Skip to content

Commit 33c3c49

Browse files
committed
docs(contributing): do not request modifications to changelog
1 parent 0781835 commit 33c3c49

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/contributing.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ If you're a first-time contributor, you can check the issues with [good first is
1515
5. Check out a new branch and add your modification.
1616
6. Add test cases for all your changes.
1717
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
18-
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit.
18+
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commmits][conventional-commmits]
1919
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
20-
9. Update `README.md` and `CHANGELOG.md` for your changes.
20+
9. Update `README.md`. Do **not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
2121
10. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
22+
23+
[conventional-commmits]: https://www.conventionalcommits.org/

0 commit comments

Comments
 (0)