You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,6 @@ Please take a moment to review this document to understand our contribution guid
22
22
23
23
This project and everyone participating in it is governed by the [js-quality-starter Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [YOUR_PROJECT_CONTACT_EMAIL].
|**ESLint**| Statically analyzes your code to quickly find and fix problems. It's configured with recommended rules to enforce best practices. |
16
+
|**Prettier**| An opinionated code formatter that enforces a consistent style across your entire codebase, eliminating arguments over code style. |
17
+
|**Jest**| A delightful JavaScript Testing Framework with a focus on simplicity. It's set up and ready for you to write unit and integration tests. |
18
+
|**markdownlint**| A linter for Markdown files to enforce consistent style and catch common errors in documentation. |
19
+
|**Husky**| Manages Git hooks to make it easy to run scripts at specific stages, like before a commit. |
20
+
|**lint-staged**| Works with Husky to run linters and formatters on your staged files _before_ they are committed, ensuring no bad code gets in. |
23
21
|**GitHub Actions**| Automates your workflow with two pre-configured CI pipelines for validating code on `main` and all other feature branches. |
24
22
25
23
## Getting Started
@@ -40,11 +38,13 @@ This template comes pre-configured with a suite of modern, industry-standard too
40
38
cd your-new-repo
41
39
```
42
40
43
-
2. Install dependencies:
44
-
```bash
45
-
npm install
46
-
```
47
-
This will install all dependencies and also run the `prepare` script, which sets up the Husky pre-commit hooks automatically.
41
+
2. Install dependencies:
42
+
43
+
```bash
44
+
npm install
45
+
```
46
+
47
+
This will install all dependencies and also run the `prepare` script, which sets up the Husky pre-commit hooks automatically.
48
48
49
49
3. Start coding!
50
50
@@ -56,8 +56,6 @@ After creating your repository from this template, be sure to:
56
56
2.**Update `LICENSE`**: Modify the `[year]` and `[fullname]` to reflect your project's ownership.
57
57
3.**Update `CODE_OF_CONDUCT.md` and `CONTRIBUTING.md`**: Replace the `[YOUR_PROJECT_CONTACT_EMAIL]` placeholder with a valid project contact email.
58
58
59
-
60
-
61
59
## Available Scripts
62
60
63
61
In the project directory, you can run:
@@ -91,14 +89,12 @@ Both workflows perform the following steps across multiple Node.js versions (18.
91
89
92
90
1.**Install dependencies** using `npm ci` for fast, reliable installs.
93
91
2.**Lint code** with `npm run lint`.
94
-
3. **Lint Markdown files** with `npm run lint:md`.
95
-
4. **Check code formatting** with `npm run format`.
96
-
5. **Check Markdown formatting** with `npm run format:md`.
97
-
6. **Check forbroken links**in Markdown with `npm run check:links`.
98
-
7. **Audit for vulnerabilities** with `npm audit --production`.
99
-
8. **Run tests** with `npm test`.
100
-
101
-
92
+
3.**Lint Markdown files** with `npm run lint:md`.
93
+
4.**Check code formatting** with `npm run format`.
94
+
5.**Check Markdown formatting** with `npm run format:md`.
95
+
6.**Check for broken links** in Markdown with `npm run check:links`.
96
+
7.**Audit for vulnerabilities** with `npm audit --production`.
97
+
8.**Run tests** with `npm test`.
102
98
103
99
## Customization
104
100
@@ -117,18 +113,20 @@ This template is configured to generate code coverage reports using Jest. The re
117
113
To get a dynamic code coverage badge like the one at the top of this `README.md`, you can integrate with a service like Codecov or Coveralls.
118
114
119
115
**Steps to set up Codecov (example):**
120
-
1. Sign up for Codecov with your GitHub account.
121
-
2. Add your repository to Codecov.
122
-
3. Codecov will provide you with a `CODECOV_TOKEN`. Add this token as a secret in your GitHub repository settings (e.g., `CODECOV_TOKEN`).
123
-
4. Add a step to your CI workflow (`.github/workflows/ci.yml`) to upload the coverage report to Codecov. This typically involves adding a step like:
124
-
```yaml
125
-
- name: Upload coverage to Codecov
126
-
uses: codecov/codecov-action@v4
127
-
with:
128
-
token: ${{ secrets.CODECOV_TOKEN }}
129
-
```
130
-
5. Update the badge URL in`README.md` with your specific repository details and token (if required by Codecov for public repos, though often not for public repos).
131
116
117
+
1. Sign up for Codecov with your GitHub account.
118
+
2. Add your repository to Codecov.
119
+
3. Codecov will provide you with a `CODECOV_TOKEN`. Add this token as a secret in your GitHub repository settings (e.g., `CODECOV_TOKEN`).
120
+
4. Add a step to your CI workflow (`.github/workflows/ci.yml`) to upload the coverage report to Codecov. This typically involves adding a step like:
121
+
122
+
```yaml
123
+
- name: Upload coverage to Codecov
124
+
uses: codecov/codecov-action@v4
125
+
with:
126
+
token: ${{ secrets.CODECOV_TOKEN }}
127
+
```
128
+
129
+
5. Update the badge URL in `README.md` with your specific repository details and token (if required by Codecov for public repos, though often not for public repos).
0 commit comments