Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

docs(contributing): add Contributing TL;DR page #1484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/contributing_tldr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,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
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ nav:
- Exit Codes: "exit_codes.md"
- Third-Party Commitizen Templates: "third-party-commitizen.md"
- Contributing: "contributing.md"
- Contributing TL;DR: "contributing_tldr.md"
- Resources: "external_links.md"

markdown_extensions:
Expand Down