CONTRIBUTING.rst

Contributing

Prerequisites

You'll need uv and just installed.

Setup

Clone the repo and run:

$ just setup

This will create a virtual environment and install all dependencies.

Pull Requests

When creating a pull request, try to:

• Write tests if applicable
• Note important changes in the CHANGES file
• Update the README file if needed
• Update the documentation if needed
• Add yourself to the AUTHORS file

Formatting & Linting

This project uses ruff for linting and formatting.

To auto-format and fix lint issues:

$ just format

To check without modifying:

$ just lint

Adding Migrations

When you add new models or make changes to models, you'll need to make migrations before the tests will run:

$ just makemigrations

Testing

To run tests on your current Python version:

$ just test

To run the full tox test matrix across Python and Django versions:

$ just test-matrix

To run tests with a coverage report (in htmlcov directory):

$ just test-cov

Documentation

To build the Sphinx documentation:

$ just docs

Releases

To release to PyPI:

1. Update the version: just bump patch (or minor/major)
2. Build: just build
3. Publish: just publish