Goal: briefly but sufficiently describe the structure of the repository so that an agent can work effectively without re-scanning the entire codebase.
<name> — <what this repository is>.
- Language:
<version> - Runtime:
<version> - Build:
<tool> - Storage/DB:
<...> - Messaging:
<...>
Describe the module structure and how the application is assembled.
Describe the layering conventions and dependency rules.
Describe the top-level package layout used by the project.
Recommended default vocabulary is app/domain/i9ns/infra/platform, with common aliases core and integrations.
List naming conventions enforced by the project.
Recommended default suffix taxonomy includes *Controller, *Listener, *Scheduler, *Op, *Repo, *Client, *Channel, *Queue, *Conf, *Rq, *View, *Rs, *Row, and *Dao.
Record any project-specific exceptions (for example, allowed *Service usage and a migration plan).
List of key directories and files.
Where the entry points are located (runtime, API, jobs, listeners).
Simplified dependency map.
Build, run, and test commands.
Rules that apply only to this project.
Record explicit deviations from framework defaults here.
For each deviation, note the overridden rule or budget, the replacement value, and the reason.
If the project uses a dedicated budget artifact, reference it here using <project-local>/....