Skip to content

Contributing

Development Basics

# install runtime deps
mamba env create -f environment.yml
conda activate hydra-suite-base
uv pip install -r requirements.txt

# docs + dev-tool deps (vulture, pydeps, pylint, mypy)
uv pip install -r requirements-docs.txt

Documentation Requirements

  • Use current package paths (hydra_suite.posekit, new core/* layout).
  • Keep command names canonical (posekit-labeler) and avoid legacy alternate spellings.
  • Run strict docs build before opening PR:
make docs-build

Code Change Expectations

  • Keep architecture boundaries clear (GUI vs core vs data).
  • Add/update docs whenever behavior or configuration semantics change.

Code Health

Run a full health check before submitting a large PR:

make audit     # dead-code + dep-graph + type-check + coverage

See the Code Health & Auditing page for details on interpreting results and the whitelist workflow for false-positive dead-code findings.

make commit-prep     # format (black + isort)
make lint-moderate   # catch serious issues
make audit           # full health snapshot (optional for small PRs)
make docs-check      # verify docs build cleanly