You are an AI coding agent (Copilot, Claude Code, Cursor, Gemini, or similar) working in this repository. Use this file as the index to the project's docs. The docs are the source of truth — read them directly and follow their rules.
| If you are... | Read |
|---|---|
| Getting oriented (what this project is, how to run it) | README.md |
| Setting up the dev environment or opening a PR | CONTRIBUTING.md |
| Writing or modifying tests | docs/testing/TEST_FORMAT.md |
| Deciding what cases to cover for a feature | docs/testing/TEST_COVERAGE.md |
| Placing a new test in the tree | docs/testing/FOLDER_STRUCTURE.md |
| Reviewing a pull request | docs/REVIEW.md |
| Identifying maintainers / points of contact | MAINTAINERS.md |
| Looking up the feature taxonomy (operators, stages, commands) | docs/feature-tree.csv |
- Writing or modifying a test → read
TEST_FORMAT.mdandFOLDER_STRUCTURE.mdbefore you start. Then checkTEST_COVERAGE.mdfor the feature category's required cases. - Reviewing a PR → read
docs/REVIEW.mdend-to-end and apply its severity levels, per-section checklist, and "what not to flag" rules. - Running the suite or setting up locally → use
README.mdfor usage andCONTRIBUTING.mdfor dev setup, hooks, and DCO. - Before committing → activate the repo's virtualenv so pre-commit hooks (which invoke
pythononPATH) succeed, and sign off every commit withgit commit -s. DCO is enforced.
When a rule lives in one of the linked docs, follow that doc — it is authoritative.