1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
Feel free to send a PR to update this file if you find anything useful. 🙇
## Environment
- Python `>=3.9`
- [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) `>=2.2.0`
## Useful commands
Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml) for a comprehensive list of commands.
### Code Changes
```bash
# Ensure you have the correct dependencies, for nix user's see below
poetry install
# Make ruff happy
poetry format
# Check if ruff and mypy are happy
poetry lint
# Check if mypy is happy in python 3.9
mypy --python-version 3.9
# Run tests in parallel.
pytest -n auto # This may take a while.
pytest -n auto <test_suite>
```
### Documentation Changes
```bash
# Build the documentation locally and check for broken links
poetry doc
```
### Nix Users
If you are using Nix, you can install poetry locally by running:
```sh
python -m venv .venv
. .venv/bin/activate
pip install -U pip && pip install poetry
poetry install
```
|
