Skip to content

Commit d317c22

Browse files
y3jo6Lee-W
authored andcommitted
docs(docs/contributing.md): update the contributing.md, add session Install before contributing and gpg install information.
1 parent 0109de2 commit d317c22

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/contributing.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@ When contributing to [commitizen](https://github.com/commitizen-tools/commitizen
66

77
If you're a first-time contributor, you can check the issues with [good first issue](https://github.com/commitizen-tools/commitizen/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag.
88

9+
## Install before contributing
10+
11+
1. Install [poetry](https://python-poetry.org/), installation [pages](https://python-poetry.org/docs/#installing-with-the-official-installer)
12+
2. Install [gpg](https://gnupg.org), installation [pages](https://gnupg.org/documentation/manuals/gnupg/Installation.html#Installation). For Mac users, you could try [homebrew](https://brew.sh/).
13+
914
## Before making a pull request
1015

1116
1. Fork [the repository](https://github.com/commitizen-tools/commitizen).
1217
2. Clone the repository from your GitHub.
1318
3. Setup development environment through [poetry](https://python-poetry.org/) (`poetry install`).
14-
4. Setup [pre-commit](https://pre-commit.com/) hook (`pre-commit install -t pre-commit -t pre-push -t commit-msg`)
19+
4. Setup [pre-commit](https://pre-commit.com/) hook (`poetry run pre-commit install -t pre-commit -t pre-push -t commit-msg`)
1520
5. Check out a new branch and add your modification.
1621
6. Add test cases for all your changes.
1722
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)

0 commit comments

Comments
 (0)