Skip to content

Commit 3a559e4

Browse files
chore: fix and update scripts and links in CONTRIBUTING.md
1 parent 01299eb commit 3a559e4

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@ Make your change. Add tests and/or documentation. Ensure all tests and lint pass
2626
```sh
2727
$ npm test
2828
$ npm run lint
29+
$ npm run lint:dts
30+
```
31+
32+
Write a commit message that follows the [Conventional Commits][commit] specification.
33+
34+
The commit message will be linted during the pre-commit Git hook.
35+
To manually lint the most recent commit message:
36+
37+
```sh
38+
$ git log -1 --pretty=format:"%s" | npx commitlint
2939
```
3040

3141
Push to your fork and [submit a pull request][pr].
@@ -42,27 +52,20 @@ Things that will improve the chance that your pull request will be accepted:
4252
- [ ] Write good documentation.
4353
- [ ] Write a [good commit message][commit].
4454

45-
[ci]: https://travis-ci.org/remarkablemark/html-react-parser
55+
[ci]: https://github.com/remarkablemark/html-react-parser/actions?query=workflow%3Abuild
4656
[commit]: https://www.conventionalcommits.org/
4757

4858
## Test
4959

50-
Run tests:
51-
52-
```sh
53-
$ npm test
54-
```
55-
5660
Run tests with coverage:
5761

5862
```sh
59-
$ npm run test:coverage
63+
$ npm test
6064
```
6165

6266
View coverage report in your browser:
6367

6468
```sh
65-
$ npm run test:coverage:report
6669
$ open coverage/index.html
6770
```
6871

@@ -80,7 +83,7 @@ Fix lint errors:
8083
$ npm run lint:fix
8184
```
8285

83-
Test TypeScript declaration file for style and correctness:
86+
Test TypeScript declaration files for style and correctness:
8487

8588
```sh
8689
$ npm run lint:dts
@@ -92,5 +95,5 @@ Only collaborators with credentials can release and publish:
9295

9396
```sh
9497
$ npm run release
95-
$ npm publish && git push --follow-tags
98+
$ git push --follow-tags && npm publish
9699
```

0 commit comments

Comments
 (0)