Skip to content

Contributing

Local setup

cd python-package
pip install -e ".[dev]"

Run tests

pytest

Run parity checks against R huge (optional)

Requires local R with package huge installed.

cd python-package
python scripts/r_parity_report.py --out parity_report.json

Build docs

mkdocs build --strict

Build release artifacts

bash scripts/build_dist.sh

Bump version

python scripts/bump_version.py 0.8.x
bash scripts/release.sh 0.8.x

Code principles

  • Keep public API aligned with huge-style semantics.
  • Keep dataclass fields backward-stable where possible.
  • Add tests for every new public behavior.
  • Document behavior changes in CHANGELOG.md.