File: contributing_tldr.md

package info (click to toggle)
commitizen 4.9.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,672 kB
  • sloc: python: 14,530; makefile: 15
file content (37 lines) | stat: -rw-r--r-- 814 bytes parent folder | download
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
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.0.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
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
```