Skip to content

Commit 1432d1f

Browse files
1 parent 898a392 commit 1432d1f

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing
2+
3+
All pull requests are welcome! By participating in this project, you
4+
agree to abide by our **[code of conduct]**.
5+
6+
[code of conduct]: https://github.com/remarkablemark/html-react-parser/blob/master/CODE_OF_CONDUCT.md
7+
8+
[Fork], then clone the repository:
9+
10+
[fork]: https://github.com/remarkablemark/html-react-parser/fork
11+
12+
```sh
13+
# replace `<user>` with your username
14+
$ git clone git@github.com:<user>/html-react-parser.git
15+
$ cd html-react-parser
16+
```
17+
18+
Install package dependencies:
19+
20+
```sh
21+
$ npm install
22+
```
23+
24+
Make your change. Add tests and/or documentation. Ensure all tests and lint pass:
25+
26+
```sh
27+
$ npm test
28+
$ npm run lint
29+
```
30+
31+
Push to your fork and [submit a pull request][pr].
32+
33+
[pr]: https://github.com/remarkablemark/html-react-parser/compare/
34+
35+
At this point you're waiting on us. We like to comment on pull requests
36+
within three business days (and, typically, one business day). We may suggest
37+
changes, improvements, or alternatives.
38+
39+
Things that will improve the chance that your pull request will be accepted:
40+
41+
- [ ] Write tests that pass [CI].
42+
- [ ] Write good documentation.
43+
- [ ] Write a [good commit message][commit].
44+
45+
[ci]: https://travis-ci.org/remarkablemark/html-react-parser
46+
[commit]: https://www.conventionalcommits.org/

0 commit comments

Comments
 (0)