- Open or reference an issue before starting major work.
- Create a focused branch from
main. - Keep pull requests narrow enough to review quickly.
- Add or update tests with every behavior change.
- Update documentation when structure, setup, or operating assumptions change.
- Prefer small, composable modules over deeply coupled services.
- Treat model configuration as code: version routing policies, prompt assets, and catalog changes.
- Keep heavyweight runtime outputs out of git.
- Document every architectural decision that changes repository shape or platform direction in
docs/adr/.
Use short, descriptive commits such as:
chore: bootstrap repository scaffoldfeat: add model routing policy loaderdocs: add AirLLM workstation guide
- The change is scoped to one clear goal.
- Tests or validation notes are included.
- Docs are updated when behavior or workflow changed.
- Secrets, cache directories, and model weights are not committed.