Skip to content

Commit 17402f6

Browse files
docs(github): update CONTRIBUTING.md
Signed-off-by: Mark <remarkablemark@users.noreply.github.com>
1 parent 8f255ae commit 17402f6

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

.github/CONTRIBUTING.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
<summary>Table of Contents</summary>
55

66
- [Test](#test)
7+
- [Fork](#fork)
78
- [Lint](#lint)
89
- [Release](#release)
910

@@ -12,32 +13,42 @@
1213
All pull requests are welcome! By participating in this project, you
1314
agree to abide by our **[code of conduct]**.
1415

15-
[code of conduct]: https://github.com/remarkablemark/html-react-parser/blob/master/.github/CODE_OF_CONDUCT.md
16+
[code of conduct]: https://github.com/remarkablemark/.github/blob/master/CODE_OF_CONDUCT.md
17+
18+
## Fork
1619

1720
[Fork], then clone the repository:
1821

1922
[fork]: https://github.com/remarkablemark/html-react-parser/fork
2023

2124
```sh
22-
# replace `<user>` with your username
23-
git clone git@github.com:<user>/html-react-parser.git && cd html-react-parser
25+
# replace <USER> with your username
26+
git clone git@github.com:<USER>/html-react-parser.git
27+
cd html-react-parser
2428
```
2529

26-
Install package dependencies:
30+
Install the package dependencies:
2731

2832
```sh
2933
npm install
3034
```
3135

32-
Make your change. Add tests and/or documentation. Ensure all tests and lint pass:
36+
Make your changes. Add tests and/or documentation. Ensure all tests and lint pass:
3337

3438
```sh
3539
npm test
3640
npm run lint
3741
npm run lint:dts
3842
```
3943

40-
Write a commit message that follows the [Conventional Commits][commit] specification.
44+
Write a commit message that follows the [Conventional Commits][commit] specification:
45+
46+
- **feat**: A new feature
47+
- **fix**: A bug fix
48+
- **perf**: A code change that improves performance
49+
- **refactor**: A code change that neither fixes a bug nor adds a feature
50+
- **test**: Adding missing tests or correcting existing tests
51+
- **docs**: Documentation only changes
4152

4253
The commit message will be linted during the pre-commit Git hook.
4354
To manually lint the most recent commit message:
@@ -46,13 +57,12 @@ To manually lint the most recent commit message:
4657
git log -1 --pretty=format:"%s" | npx commitlint
4758
```
4859

49-
Push to your fork and [submit a pull request][pr].
60+
Push to your fork and [create a pull request][pr].
5061

5162
[pr]: https://github.com/remarkablemark/html-react-parser/compare/
5263

53-
At this point you're waiting on us. We like to comment on pull requests
54-
within three business days (and, typically, one business day). We may suggest
55-
changes, improvements, or alternatives.
64+
At this point you're waiting on us. We'll try to review pull requests within
65+
1-3 business days. We may suggest changes, improvements, and/or alternatives.
5666

5767
Things that will improve the chance that your pull request will be accepted:
5868

@@ -61,7 +71,7 @@ Things that will improve the chance that your pull request will be accepted:
6171
- [ ] Write a [good commit message][commit].
6272

6373
[ci]: https://github.com/remarkablemark/html-react-parser/actions/workflows/build.yml
64-
[commit]: https://www.conventionalcommits.org/
74+
[commit]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
6575

6676
## Test
6777

@@ -71,15 +81,21 @@ Run tests with coverage:
7181
npm test
7282
```
7383

74-
View coverage report in your browser:
84+
Run tests in watch mode:
85+
86+
```sh
87+
npm run test:watch
88+
```
89+
90+
View the coverage report in your browser:
7591

7692
```sh
7793
open coverage/lcov-report/index.html
7894
```
7995

8096
## Lint
8197

82-
Lint codebase:
98+
Run ESLint:
8399

84100
```sh
85101
npm run lint
@@ -91,7 +107,7 @@ Fix lint errors:
91107
npm run lint:fix
92108
```
93109

94-
Test TypeScript declaration files for style and correctness:
110+
Type check TypeScript declaration files:
95111

96112
```sh
97113
npm run lint:dts

0 commit comments

Comments
 (0)