4
4
<summary >Table of Contents</summary >
5
5
6
6
- [ Fork] ( #fork )
7
+ - [ Install] ( #install )
8
+ - [ Develop] ( #develop )
7
9
- [ Test] ( #test )
8
10
- [ Lint] ( #lint )
9
11
- [ Release] ( #release )
10
12
11
13
</details >
12
14
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 ) .
17
17
18
18
## Fork
19
19
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:
23
21
24
22
``` sh
25
23
# replace <USER> with your username
26
24
git clone git@github.com:< USER> /html-react-parser.git
25
+ ```
26
+
27
+ ``` sh
27
28
cd html-react-parser
28
29
```
29
30
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 ) :
31
34
32
35
``` sh
33
36
nvm use
34
37
```
35
38
36
- Install the package dependencies:
39
+ Install the dependencies:
37
40
38
41
``` sh
39
42
npm install
40
43
```
41
44
45
+ ## Develop
46
+
42
47
Make your changes, add tests/documentation, and ensure tests and lint pass:
43
48
44
49
``` sh
45
50
npm test
51
+ ```
52
+
53
+ ``` sh
46
54
npm run lint
47
- npm run lint:dts
48
55
```
49
56
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:
51
62
52
63
- ** feat** : A new feature
53
64
- ** fix** : A bug fix
54
65
- ** perf** : A code change that improves performance
55
66
- ** refactor** : A code change that neither fixes a bug nor adds a feature
56
67
- ** 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
57
70
- ** docs** : Documentation only changes
58
71
59
72
The commit message will be linted during the pre-commit Git hook.
@@ -63,21 +76,16 @@ To manually lint the most recent commit message:
63
76
git log -1 --pretty=format:" %s" | npx commitlint
64
77
```
65
78
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/ ) .
69
80
70
81
At this point, wait for us to review your pull request. We'll try to review pull requests within
71
82
1-3 business days. We may suggest changes, improvements, and/or alternatives.
72
83
73
84
Things that will improve the chance that your pull request will be accepted:
74
85
75
- - [ ] Write tests that pass [ CI] .
86
+ - [ ] Write tests that pass [ CI] ( https://github.com/remarkablemark/html-react-parser/actions/workflows/build.yml ) .
76
87
- [ ] 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 ) .
81
89
82
90
## Test
83
91
@@ -121,6 +129,4 @@ npm run lint:dts
121
129
122
130
## Release
123
131
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