Skip to content

index.md

Latest commit

 

History

History
43 lines (26 loc) · 2.1 KB

index.md

File metadata and controls

43 lines (26 loc) · 2.1 KB
Raw

How to Contribute

kaits is in early development. The core MVP is being built now; most of the architecture is still being validated. Contributions are welcome, but expect things to move fast and change frequently.

Ways to Contribute

  • Bug reports — Open a GitHub issue with a clear description of what happened, what you expected, and how to reproduce it.
  • Feature requests — Open an issue describing the use case and why it matters. Link to a relevant backlog item (BACK-NNN) if one exists.
  • Pull requests — Fork the repo, create a feature branch, make your changes, and open a PR against main. See the branching convention below.
  • Documentation — Corrections, clarifications, and new how-to guides are always welcome. Follow the same branching and PR process.

Branching Convention

kaits uses a feature-branch workflow:

  • main is the stable trunk. All work merges back to main via merge commits.
  • Feature branches follow the format back-NNN/short-description, where NNN is the backlog item ID (e.g., back-004/mvp-dashboard, back-011/how-to-docs).
  • Use merge commits (not squash) so the full history is preserved. The merge commit message must reference the BACK-NNN ID.

If your contribution does not correspond to an existing backlog item, open an issue first so a BACK-NNN ID can be assigned.

Commit Messages

Reference the backlog item in every commit message:

feat: add researcher agent card (BACK-004)

Co-Authored-By: Your Name <your@email.com>

Keep messages concise. Lead with the change type (feat, fix, docs, refactor, chore), then a short description, then the backlog reference in parentheses.

Code Style

  • Python: formatted and linted with ruff. Run uv run ruff check before opening a PR.
  • No style exceptions — the CI check must pass.

Code of Conduct

All contributors are expected to follow the Code of Conduct. Participation in this project constitutes acceptance of those terms.

See Development Setup for how to get the project running locally.