Skip to content

Commit

Permalink
Merge pull request #409 from commitizen-tools/docs/contributing-update
Browse files Browse the repository at this point in the history
docs(contributing): do not request modifications to changelog
  • Loading branch information
woile authored Aug 2, 2021
2 parents 0781835 + 33c3c49 commit 07ac1ea
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ If you're a first-time contributor, you can check the issues with [good first is
5. Check out a new branch and add your modification.
6. Add test cases for all your changes.
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit.
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commmits][conventional-commmits]
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
9. Update `README.md` and `CHANGELOG.md` for your changes.
9. Update `README.md`. Do **not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
10. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏

[conventional-commmits]: https://www.conventionalcommits.org/

0 comments on commit 07ac1ea

Please sign in to comment.