What problem does it solve?
AGENTS.md acts as a living engineering reality guide for AI agents and human contributors, clarifying rules, workflows, and boundaries to keep projects safe, testable, and consistent across environments.
Core Features & Use Cases
- Living documentation provides concise, actionable guidance for onboarding and governance.
- Multiple AGENTS.md in a monorepo, with per-directory specificity, ensures local rules override global ones.
- It covers essential sections such as Quick Commands, Project Overview, Architecture, Data Flow, Persistence, Code Style, Safety, and Testing, and requires regular updates to reflect changes.
- Use cases include onboarding AI agents, standardizing workflows across environments (e.g., Godot + SDK + demo apps), and enforcing safety boundaries in sandboxed contexts.
Quick Start
Copy this AGENTS.md into your repository and keep it updated as changes occur to guide AI agents and human contributors.