Contributing
This is the short version. The full policy is in the root
CONTRIBUTING.md.
Bug reports, proposals and focused pull requests are welcome. A code change
needs an accepted issue and a maintainer's /approve @your-handle on it before
any PR, and PRs from unapproved contributors are closed automatically. The
issue templates, the gate and working from a fork are in the full policy; report
security issues privately (SECURITY.md).
Own your code
You must understand and own every line you submit. Writing code with AI is fine: Halo itself is built with AI, and the images ship skills that teach an agent this codebase. Submitting code you can't explain is not. The PR template asks you to disclose the scaffold and models you used.
Checklist
Issue, approval, then a focused PR. Keep the diff under about 2,000 lines.
Pull or build the image and run the gates:
Bash
make lint && make format # host make docs # host (stdlib Python 3.12+): links, anchors and code references make seed-hf-cache # image: Hub configs and tokenizers the CPU tests read make test-cpu # image, no GPU needed make test-gpu-core # image, for GPU-affecting changesRe-run
make seed-hf-cachewhentests/common/models.pyorexamples/add a Hub repo. Hosted CI runs only lint, the convention tests and the docs checks, so report your test results in the PR. A change to a path in.github/sensitive-pathsalso needs thesensitivelabel from a maintainer.Ship tests that fail when the behavior breaks. Smoke-only tests and
assert x is not Nonedon't count. See the test guide inagent-docs/contributing/↗.Sign every commit (SSH or GPG), forks included. PRs are squash-merged, and GitHub won't merge one while any commit lacks a verified signature. Setup and re-signing are in
CONTRIBUTING.md.Never commit secrets,
.envor keys.
Building images, running tests and the docs tooling are covered in Development environment ↗.
Source on GitHubUpdated 18 November 2026