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
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ If you're a first-time contributor, you can check the issues with [good first is
18
18
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commmits][conventional-commmits]
19
19
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
20
20
9. Update `README.md`. Do **not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
21
-
10. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
21
+
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.
22
+
11. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
0 commit comments