Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (35 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 1.6 KB
Raw

Contributing

Thanks for taking the time to contribute.

Set up

git clone https://github.com/max-models/template-python.git
cd template-python
make install          # uv sync with the dev extra and the pre-commit hooks

Without uv:

python -m venv env && source env/bin/activate
pip install -e ".[dev]"
pre-commit install

Develop

  • Format and lint with ruff; the pre-commit hooks run it for you.
  • Type-check with pyright src/.
  • Add tests under src/<package>/tests/ and run pytest ..
  • Every public module, class and function needs a Google-style docstring. They are rendered in the API reference and checked by ruff's D rules.
  • Preview the documentation with make docs-dev; see the docs guide.

Commit messages

Commits follow Conventional Commits: feat:, fix:, docs:, chore:, refactor:, test:, ci:. A feat!: or a BREAKING CHANGE: footer marks a breaking change. Before a release, update the package version and changelog manually.

Pull requests

Open the PR against devel. CI runs the tests on every supported Python version, ruff, pyright, the tutorials and the documentation build. One approving review is required to merge.

Releases

Before merging a release to main, update the versions in pyproject.toml, src/app/__init__.py and CITATION.cff (including its release date), and add the release notes to CHANGELOG.md. The push creates a GitHub release with a version tag and publishes the package to PyPI.