Commit d317c22

y3jo6Lee-W

authored and

committed

docs(docs/contributing.md): update the contributing.md, add session Install before contributing and gpg install information.

1 parent 0109de2 commit d317c22Copy full SHA for d317c22

File tree

1 file changed

-1

lines changed

docs
- contributing.md

1 file changed

-1

lines changed

`‎docs/contributing.md‎`

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,17 @@ When contributing to [commitizen](https://github.com/commitizen-tools/commitizen`
`6`	`6`
`7`	`7`	`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.`
`8`	`8`
	`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`	`+`
`9`	`14`	`## Before making a pull request`
`10`	`15`
`11`	`16`	`1. Fork [the repository](https://github.com/commitizen-tools/commitizen).`
`12`	`17`	`2. Clone the repository from your GitHub.`
`13`	`18`	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`)
`15`	`20`	`5. Check out a new branch and add your modification.`
`16`	`21`	`6. Add test cases for all your changes.`
`17`	`22`	`(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit d317c22

File tree

1 file changed

1 file changed

`‎docs/contributing.md‎`

0 commit comments