File tree Expand file tree Collapse file tree 2 files changed +29
-0
lines changed Expand file tree Collapse file tree 2 files changed +29
-0
lines changed Original file line number Diff line number Diff line change
1
+ Feel free to send a PR to update this file if you find anything useful. 🙇
2
+
3
+ ## Environment
4
+
5
+ - Python ` >=3.9 `
6
+ - [ Poetry] ( https://python-poetry.org/docs/#installing-with-the-official-installer ) ` >=2.0.0 `
7
+
8
+ ## Useful commands
9
+
10
+ Please check the [ pyproject.toml] ( https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml ) for a comprehensive list of commands.
11
+
12
+ ``` bash
13
+ # Ensure you have the correct dependencies
14
+ poetry install
15
+
16
+ # Make ruff happy
17
+ poetry format
18
+
19
+ # Check if ruff and mypy are happy
20
+ poetry lint
21
+
22
+ # Check if mypy is happy in python 3.9
23
+ mypy --python-version 3.9
24
+
25
+ # Run tests in parallel.
26
+ pytest -n auto # This may take a while.
27
+ pytest -n auto < test_suite>
28
+ ```
Original file line number Diff line number Diff line change 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 :
You can’t perform that action at this time.
0 commit comments