Definition: A conventional Markdown file used to provide Coding Agents with project Context, rules, build/test commands, and conventions.
Simply put: It is like a README specifically for an Agent; by reading it, the Agent understands how to work with the repository.
Examples:
- “Use
uv syncto install dependencies.” - “Run
pytestafter every change.” - “Use
snake_casefor functions.”
For example:
AGENTS.md
├── Project rules
├── Setup commands
├── Test commands
├── Code style
└── Security rules