# AGENTS.md

<!--
Template from methodkeep.com/agents-md. Free to use, change and share.

AGENTS.md is plain Markdown for coding agents. Codex reads it, and so do
Cursor and many other tools. Claude Code reads it when the project has no
CLAUDE.md. There are no required fields: keep the headings that help and
delete the rest.

Codex caps the combined size of all AGENTS.md files it loads (32 KiB by
default), so keep it short and specific.
Replace every "..." and delete these comments when you're done.
-->

## Project overview

- What this is: ...
- Main folders: `...`
- Project status lives in: `project/status.json`

## Build and test commands

<!-- Exact, copy-pasteable commands. "Done means" is the check that proves the work is finished. -->

- Install: `...`
- Build: `...`
- Test: `...`
- Done means: `...` passes

## Working rules

- For changes to more than a few files, describe the plan first and wait for approval.
- After meaningful work, update the project status file: what's done, what's next, what's waiting on the owner.
- Show evidence when you say something works: the command you ran and its output.
- Commit only the files you changed, by name. Never `git add .` or `git add -A`.
- If the same check fails three times, stop and report what you tried.

## Code style

<!-- Only rules that differ from the defaults of your language. Delete if none. -->

- ...

## Testing instructions

- Run the tests for the code you changed before you finish.
- Add or update tests for the behaviour you changed.

## Security

<!-- Think of secrets, credentials, generated folders and files another tool owns. -->

- Never print, copy or commit secrets.
- Don't edit: `...`
- Don't deploy, publish, send or delete anything without explicit approval.

## Subfolders

<!--
For instructions that only apply to one part of the project, add another
AGENTS.md in that subfolder. The file closest to the work takes precedence.
-->