Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
18 lines (15 loc) · 521 Bytes

CONTRIBUTING.md

File metadata and controls

18 lines (15 loc) · 521 Bytes

Contributing to this project

Quick start

  1. Install dev deps: 
    pip install -e .[tester,linter,mypy,formatter]
pre-commit install
  2. Run checks: 
    pre-commit run --all-files && pytest -q

The repository pins tool versions in both pre-commit and optional dependencies so local runs and CI use the same formatter, linter, and type checker versions.

Commit style

  • Keep pull requests focused and add tests for bug fixes.
  • Update CHANGELOG.md for user-visible changes.