Skip to content

Commit 10f8e22

Browse files
committed
docs(contributing): add Contributing TL;DR page
1 parent 4b6b3fb commit 10f8e22

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

docs/contributing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ If you're a first-time contributor, you can check the issues with the [good firs
5353
```
5454
2. **Make Your Changes**
5555
- Write your code
56+
- Run `poetry format` to make sure `ruff` and `mypy` are happy
5657
- Add tests for new functionalities or fixes
5758
- Update documentation if needed
5859
- Follow the existing code style

docs/contributing_tldr.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff 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+
```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ nav:
5858
- Exit Codes: "exit_codes.md"
5959
- Third-Party Commitizen Templates: "third-party-commitizen.md"
6060
- Contributing: "contributing.md"
61+
- Contributing TL;DR: "contributing_tldr.md"
6162
- Resources: "external_links.md"
6263

6364
markdown_extensions:

0 commit comments

Comments
 (0)