Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (19 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.13 KB
Raw

Contributing

Contributions should strengthen the compiler, exactness checks, diagnostic harness or reproducibility of the published result. This is not a production optimisation project.

Development setup

git clone https://github.com/CodingCossack/changeaware-coreai.git
cd changeaware-coreai
uv sync --extra dev --no-editable
.venv/bin/python -m pytest
.venv/bin/ruff check .
.venv/bin/ruff format --check .

Portable changes must pass on Python 3.11–3.13 without Core AI. Native Core AI changes must state the macOS/Xcode/Core AI versions used and attach compact measurements rather than generated assets.

Evidence rules

  • Keep exact raw observations required to audit a claim.
  • Regenerate evidence/SHA256SUMS after changing evidence.
  • Never commit model weights, .aimodel bundles, .mlirb, private machine paths or diagnostics.
  • Separate observed data from interpretation and negative results from implementation defects.
  • New cache sharing must fail closed unless canonical contracts are identical.

Pull requests should explain the claim changed, the tests run and whether any documented benchmark value changed.