Skip to content

Commit 89df39e

Browse files
committed
docs(contributing): add pre-commit setup
1 parent 7029c08 commit 89df39e

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/contributing.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ If you're a first-time contributor, you can check the issues with [good first is
1111
1. Fork [the repository](https://github.com/commitizen-tools/commitizen).
1212
2. Clone the repository from your GitHub.
1313
3. Setup development environment through [poetry](https://python-poetry.org/) (`poetry install`).
14-
4. Check out a new branch and add your modification.
15-
5. Add test cases for all your changes.
14+
4. Setup [pre-commit](https://pre-commit.com/) hook (`pre-commit install -t pre-commit -t pre-push`)
15+
5. Check out a new branch and add your modification.
16+
6. Add test cases for all your changes.
1617
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
17-
6. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit.
18-
7. Run `./scripts/reformat` and `./scripts/test` to ensure you follow the coding style and the tests pass.
19-
8. Update `READMD.md` and `CHANGELOG.md` for your changes.
20-
9. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
18+
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit.
19+
8. Run `./scripts/reformat` and `./scripts/test` to ensure you follow the coding style and the tests pass.
20+
9. Update `READMD.md` and `CHANGELOG.md` for your changes.
21+
10. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏

0 commit comments

Comments
 (0)