Commit 10f8e22

committed

docs(contributing): add Contributing TL;DR page

1 parent 4b6b3fb commit 10f8e22Copy full SHA for 10f8e22

File tree

+28

-0

lines changed

+28

-0

lines changed

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ If you're a first-time contributor, you can check the issues with the [good firs`
`53`	`53`	```
`54`	`54`	`2. Make Your Changes`
`55`	`55`	`- Write your code`
	`56`	+ - Run `poetry format` to make sure `ruff` and `mypy` are happy
`56`	`57`	`- Add tests for new functionalities or fixes`
`57`	`58`	`- Update documentation if needed`
`58`	`59`	`- Follow the existing code style`

Lines changed: 26 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,26 @@`
	`1`	`+## Environment`
	`2`	`+`
	`3`	+- Python `>=3.9`
	`4`	+- [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) `>=2.0.0`
	`5`	`+`
	`6`	`+## Useful commands`
	`7`	`+`
	`8`	`+Please check the [pyproject.toml](../pyproject.toml) for a comprehensive list of commands.`
	`9`	`+`
	`10`	+```bash
	`11`	`+# Ensure you have the correct dependencies`
	`12`	`+poetry install`
	`13`	`+`
	`14`	`+# Make ruff happy`
	`15`	`+poetry format`
	`16`	`+`
	`17`	`+# Check if ruff and mypy are happy`
	`18`	`+poetry lint`
	`19`	`+`
	`20`	`+# Check if mypy is happy in python 3.9`
	`21`	`+mypy --python-version 3.9`
	`22`	`+`
	`23`	`+# Run tests in parallel.`
	`24`	`+pytest -n auto # This may take a while.`
	`25`	`+pytest -n auto <test_suite>`
	`26`	+```

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ nav:`
`58`	`58`	`- Exit Codes: "exit_codes.md"`
`59`	`59`	`- Third-Party Commitizen Templates: "third-party-commitizen.md"`
`60`	`60`	`- Contributing: "contributing.md"`
	`61`	`+ - Contributing TL;DR: "contributing_tldr.md"`
`61`	`62`	`- Resources: "external_links.md"`
`62`	`63`
`63`	`64`	`markdown_extensions:`

Comments

(0)