Skip to content

Commit 522bb86

Browse files
docs(github): update CONTRIBUTING.md
1 parent 3e6b4a1 commit 522bb86

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

.github/CONTRIBUTING.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,69 @@
44
<summary>Table of Contents</summary>
55

66
- [Fork](#fork)
7+
- [Install](#install)
8+
- [Develop](#develop)
79
- [Test](#test)
810
- [Lint](#lint)
911
- [Release](#release)
1012

1113
</details>
1214

13-
All pull requests are welcome! By participating in this project, you
14-
agree to abide by our **[code of conduct]**.
15-
16-
[code of conduct]: https://github.com/remarkablemark/.github/blob/master/CODE_OF_CONDUCT.md
15+
Pull requests are welcome! By participating in this project, you
16+
agree to abide by our [code of conduct](https://github.com/remarkablemark/.github/blob/master/CODE_OF_CONDUCT.md).
1717

1818
## Fork
1919

20-
[Fork], then clone the repository:
21-
22-
[fork]: https://github.com/remarkablemark/html-react-parser/fork
20+
[Fork](https://github.com/remarkablemark/html-react-parser/fork) and then clone the repository:
2321

2422
```sh
2523
# replace <USER> with your username
2624
git clone git@github.com:<USER>/html-react-parser.git
25+
```
26+
27+
```sh
2728
cd html-react-parser
2829
```
2930

30-
Use [nvm](https://github.com/nvm-sh/nvm#intro) to set the Node.js version:
31+
## Install
32+
33+
Set the Node.js version with [nvm](https://github.com/nvm-sh/nvm#intro):
3134

3235
```sh
3336
nvm use
3437
```
3538

36-
Install the package dependencies:
39+
Install the dependencies:
3740

3841
```sh
3942
npm install
4043
```
4144

45+
## Develop
46+
4247
Make your changes, add tests/documentation, and ensure tests and lint pass:
4348

4449
```sh
4550
npm test
51+
```
52+
53+
```sh
4654
npm run lint
47-
npm run lint:dts
4855
```
4956

50-
Write a commit message that follows the [Conventional Commits][commit] specification:
57+
```sh
58+
npm run lint:tsc
59+
```
60+
61+
Write a commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/) specification:
5162

5263
- **feat**: A new feature
5364
- **fix**: A bug fix
5465
- **perf**: A code change that improves performance
5566
- **refactor**: A code change that neither fixes a bug nor adds a feature
5667
- **test**: Adding missing tests or correcting existing tests
68+
- **build**: Changes that affect the build system or external dependencies
69+
- **ci**: Changes to our CI configuration files and scripts
5770
- **docs**: Documentation only changes
5871

5972
The commit message will be linted during the pre-commit Git hook.
@@ -63,21 +76,16 @@ To manually lint the most recent commit message:
6376
git log -1 --pretty=format:"%s" | npx commitlint
6477
```
6578

66-
Push to your fork and [create a pull request][pr].
67-
68-
[pr]: https://github.com/remarkablemark/html-react-parser/compare/
79+
Push to your fork and create a [pull request](https://github.com/remarkablemark/html-react-parser/compare/).
6980

7081
At this point, wait for us to review your pull request. We'll try to review pull requests within
7182
1-3 business days. We may suggest changes, improvements, and/or alternatives.
7283

7384
Things that will improve the chance that your pull request will be accepted:
7485

75-
- [ ] Write tests that pass [CI].
86+
- [ ] Write tests that pass [CI](https://github.com/remarkablemark/html-react-parser/actions/workflows/build.yml).
7687
- [ ] Write good documentation.
77-
- [ ] Write a [good commit message][commit].
78-
79-
[ci]: https://github.com/remarkablemark/html-react-parser/actions/workflows/build.yml
80-
[commit]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
88+
- [ ] Write a good [commit message](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
8189

8290
## Test
8391

@@ -121,6 +129,4 @@ npm run lint:dts
121129

122130
## Release
123131

124-
Release and publish are automated with [Release Please].
125-
126-
[release please]: https://github.com/googleapis/release-please
132+
Release and publish are automated with [Release Please](https://github.com/googleapis/release-please).

0 commit comments

Comments
 (0)