Commit 53eb84c

committed

docs(contributing): add instruction about how to test documentation

1 parent edfb2ca commit 53eb84cCopy full SHA for 53eb84c

File tree

-1

lines changed

-1

lines changed

Lines changed: 2 additions & 1 deletion

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 it locally and check if there exists any error or warning.
	`22`	`+11. Send a [pull request](https://github.com/commitizen-tools/commitizen/pulls) 🙏`
`22`	`23`
`23`	`24`	`[conventional-commmits]: https://www.conventionalcommits.org/`

Comments

(0)