Commit 195ed16

bearomorphismLee-W

authored and

committed

docs(contributing-tldr): add documentation changes section

1 parent a4c87bc commit 195ed16Copy full SHA for 195ed16

File tree

-0

lines changed

-0

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ Feel free to send a PR to update this file if you find anything useful. 🙇`
`9`	`9`
`10`	`10`	`Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml) for a comprehensive list of commands.`
`11`	`11`
	`12`	`+### Code Changes`
	`13`	`+`
`12`	`14`	```bash
`13`	`15`	`# Ensure you have the correct dependencies`
`14`	`16`	`poetry install`
`@@ -26,3 +28,10 @@ mypy --python-version 3.9`
`26`	`28`	`pytest -n auto # This may take a while.`
`27`	`29`	`pytest -n auto <test_suite>`
`28`	`30`	```
	`31`	`+`
	`32`	`+### Documentation Changes`
	`33`	`+`
	`34`	+```bash
	`35`	`+# Build the documentation locally and check for broken links`
	`36`	`+poetry doc`
	`37`	+```

Comments

(0)