Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (19 loc) · 758 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 758 Bytes
Raw

Contributing

Setup

git clone https://github.com/henrychentp/runmaxxing.git
cd runmaxxing
python3 -m pip install -e ".[dev]"

Check

runmaxxing-check
pytest tests/ -q

The frozen-week test must still pick the same session. Do not change tests/fixtures/week_build/expected.json unless the pick change is the point of the pull request.

Changes

  • Open a pull request against main.
  • Keep live health files and tokens off the tree.
  • Put your personal numbers in data/athlete.json (gitignored). Do not edit athlete.example.json unless you are changing the public example athlete.
  • Keep JSON output stable (dump_json): sorted keys, 2-space indent, trailing newline.
  • Load SKILL.md before changing input shapes.