You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/contributing.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
First of all, thank you for taking the time to contribute! 🎉
4
4
5
-
When contributing to [commitizen](https://github.com/commitizen-tools/commitizen), please first create an [issue](https://github.com/commitizen-tools/commitizen/issues) to discuss the change you wish to make before making a change.
5
+
When contributing to [commitizen](https://github.com/czplus-tools/commitizen-plus), please first create an [issue](https://github.com/czplus-tools/commitizen-plus/issues) to discuss the change you wish to make before making a change.
6
6
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.
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. # Todo: Check good issue
8
8
9
9
## Install before contributing
10
10
@@ -13,20 +13,20 @@ If you're a first-time contributor, you can check the issues with [good first is
3. Setup development environment through [poetry](https://python-poetry.org/) (`poetry install`).
19
19
4. Setup [pre-commit](https://pre-commit.com/) hook (`poetry run pre-commit install`)
20
20
5. Check out a new branch and add your modification.
21
21
6. Add test cases for all your changes.
22
22
(We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
23
-
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commits](https://www.conventionalcommits.org/).
23
+
7. Use [commitizen-plus](https://github.com/czplus-tools/commitizen-plus) to do git commit. We follow [conventional commits](https://www.conventionalcommits.org/).
24
24
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
25
25
9. Optionally, update the `./docs/README.md`.
26
-
9.**Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
27
-
10.**Do not** update the versions in the project, they will be automatically updated.
28
-
10. If your changes are about documentation. Run `poetry run mkdocs serve` to serve documentation locally and check whether there is any warning or error.
29
-
11. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
26
+
10.**Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
27
+
11.**Do not** update the versions in the project, they will be automatically updated.
28
+
12. If your changes are about documentation. Run `poetry run mkdocs serve` to serve documentation locally and check whether there is any warning or error.
29
+
13. Send a [pull request](https://github.com/czplus-tools/commitizen-plus/pulls) 🙏
0 commit comments