Skip to content

Commit 53c00a6

Browse files
chore: remove standard-version and update CONTRIBUTING.md
1 parent 47aed22 commit 53c00a6

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Contributing
22

3+
<details>
4+
<summary>Table of Contents</summary>
5+
6+
- [Test](#test)
7+
- [Lint](#lint)
8+
- [Release](#release)
9+
10+
</details>
11+
312
All pull requests are welcome! By participating in this project, you
413
agree to abide by our **[code of conduct]**.
514

@@ -11,22 +20,21 @@ agree to abide by our **[code of conduct]**.
1120

1221
```sh
1322
# replace `<user>` with your username
14-
$ git clone git@github.com:<user>/html-react-parser.git
15-
$ cd html-react-parser
23+
git clone git@github.com:<user>/html-react-parser.git && cd html-react-parser
1624
```
1725

1826
Install package dependencies:
1927

2028
```sh
21-
$ npm install
29+
npm install
2230
```
2331

2432
Make your change. Add tests and/or documentation. Ensure all tests and lint pass:
2533

2634
```sh
27-
$ npm test
28-
$ npm run lint
29-
$ npm run lint:dts
35+
npm test
36+
npm run lint
37+
npm run lint:dts
3038
```
3139

3240
Write a commit message that follows the [Conventional Commits][commit] specification.
@@ -35,7 +43,7 @@ The commit message will be linted during the pre-commit Git hook.
3543
To manually lint the most recent commit message:
3644

3745
```sh
38-
$ git log -1 --pretty=format:"%s" | npx commitlint
46+
git log -1 --pretty=format:"%s" | npx commitlint
3947
```
4048

4149
Push to your fork and [submit a pull request][pr].
@@ -60,40 +68,35 @@ Things that will improve the chance that your pull request will be accepted:
6068
Run tests with coverage:
6169

6270
```sh
63-
$ npm test
71+
npm test
6472
```
6573

6674
View coverage report in your browser:
6775

6876
```sh
69-
$ open coverage/index.html
77+
open coverage/lcov-report/index.html
7078
```
7179

7280
## Lint
7381

7482
Lint codebase:
7583

7684
```sh
77-
$ npm run lint
85+
npm run lint
7886
```
7987

8088
Fix lint errors:
8189

8290
```sh
83-
$ npm run lint:fix
91+
npm run lint:fix
8492
```
8593

8694
Test TypeScript declaration files for style and correctness:
8795

8896
```sh
89-
$ npm run lint:dts
97+
npm run lint:dts
9098
```
9199

92100
## Release
93101

94-
Only collaborators with credentials can release and publish:
95-
96-
```sh
97-
$ npm run release
98-
$ git push --follow-tags && npm publish
99-
```
102+
Release is automated by [Release Please](https://github.com/googleapis/release-please).

package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
"postinstall": "husky install",
1616
"postpublish": "pinst --enable",
1717
"prepublishOnly": "pinst --disable && npm run lint && npm run lint:dts && npm run test:ci && npm run clean && npm run build",
18-
"release": "standard-version --no-verify",
1918
"size-limit": "size-limit",
2019
"test": "jest --coverage --testPathIgnorePatterns test/integration/",
2120
"test:ci": "npm test -- --ci",
@@ -67,7 +66,6 @@
6766
"rollup": "2.56.3",
6867
"rollup-plugin-terser": "7.0.2",
6968
"size-limit": "5.0.3",
70-
"standard-version": "9.3.1",
7169
"typescript": "4.4.2"
7270
},
7371
"peerDependencies": {

0 commit comments

Comments
 (0)