Skip to content

Commit 53eb84c

Browse files
committed
docs(contributing): add instruction about how to test documentation
1 parent edfb2ca commit 53eb84c

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/contributing.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ If you're a first-time contributor, you can check the issues with [good first is
1818
7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commmits][conventional-commmits]
1919
8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
2020
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 it locally and check if there exists any error or warning.
22+
11. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏
2223

2324
[conventional-commmits]: https://www.conventionalcommits.org/

0 commit comments

Comments
 (0)