Enhance contribute page

docs/README.md

@@ -104,7 +104,7 @@ commands:
 
 ## Third-Party Commitizen Templates
 
-See [docs/third-party-commitizen.md](third-party-commitizen.md).
+See [Third-Party Commitizen Templates](third-party-commitizen.md).
 
 ## FAQ
 
@@ -124,12 +124,7 @@ git commit -m "revert: foo bar"
 
 ## Contributing
 
-Feel free to create a PR.
-
-1. Clone the repo.
-2. Add your modifications
-3. Create a virtualenv
-4. Run `./scripts/test`
+See [Contributing](contributing.md)
 
 [conventional_commits]: https://www.conventionalcommits.org
 [semver]: https://semver.org/

docs/contributing.md

@@ -0,0 +1,20 @@
+## Contributing to commitizen
+
+First of all, thank you for taking the time to contribute! 🎉
+
+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.
+
+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.
+
+## Before making a pull request
+
+1. Fork [the repository](https://github.com/commitizen-tools/commitizen)
+2. Clone the repository from you GitHub
+3. Setup development environment through [poetry](https://python-poetry.org/) (`poetry install`)
+4. Check out a new branch and add your modification
+5. Add test cases for all your changes  
+   (We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
+6. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit
+7. Run `./scripts/lint` and `./scripts/test` to ensure you follow the coding style and the tests pass
+8. Update `READMD.md` and `CHANGELOG.md` for your changes
+9. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏

mkdocs.yml

@@ -10,16 +10,18 @@ edit_uri: ""
 
 nav:
     - Introduction: 'README.md'
-    - Configuration: 'config.md'
     - Commands:
+        - Init: 'init.md'
         - Bump: 'bump.md'
         - Check: 'check.md'
-        - Init: 'init.md'
+    - Configuration: 'config.md'
     - Customization: 'customization.md'
     - Tutorials:
         - Writing commits: 'tutorials/writing_commits.md'
         - GitLab CI: 'tutorials/gitlab_ci.md'
         - Github Actions: 'tutorials/github_actions.md'
+    - Third-Party Commitizen Templates: 'third-party-commitizen.md'
+    - Contributing: 'contributing.md'
 
 markdown_extensions:
   - markdown.extensions.codehilite: