Guidance for AI coding agents working in this repository.
This file is a map, not a rulebook. The contributor documentation is the authority, and everything below points into it rather than restating it, so that the two cannot disagree.
Read the AI guidelines first. Rook does not accept contributions that lack human oversight.
Read the relevant section of the developer guide before making a change:
| To find out how to | Read |
|---|---|
| build, test, and lint, and what CI enforces | Checks that gate a pull request |
change anything under pkg/apis |
Generated Code and CRDs |
| write a commit message | Commit structure |
| fill in the pull request checklist | the pull request template, which says what each item claims |
| write tests | Assertions |
Two of these are easy to miss. Building or testing with a bare go command does not necessarily
match what CI runs, so use make. Changing a godoc comment under pkg/apis counts as changing the
API, because those comments become the CRD descriptions.
- Sign off every commit with
git commit -s. A bot enforces the DCO. - Open pull requests against
master, from a branch in a fork. Rebase onto upstream; never merge upstream into a branch. - If you do not have write access, keep no more than three pull requests open at once; the repository enforces this. It does not apply to contributors with write access. Ask a maintainer if you have a genuine need to exceed it.
- Opening a pull request non-interactively, such as by passing a body to
gh pr create, skips the template that GitHub would otherwise supply. Read the template and fill in its checklist regardless. - Disclose in the pull request description how AI tools assisted with the change.
- Commit messages and review comments are the contributor's own reasoning to explain and own. Do not submit raw model output as either.
- Discuss significant changes in an issue before writing code. Large AI-generated pull requests without prior design discussion will be rejected.