AGENTS.md — Open Format for Coding Agent Instructions

Dev environment tips

• Prefer the project package manager (pnpm/uv/poetry) and keep commands reproducible.
• Run the smallest test suite first, then full CI before merging.

Testing instructions

• Find the CI plan under .github/workflows/.
• Run unit tests locally before pushing.

PR instructions

• Keep PRs small and link to the issue/task.
• Never merge red CI. MD

2. Start / smoke test:

   sed -n '1,200p' AGENTS.md

3. Verify:
   • Ask your coding agent to follow only the instructions in AGENTS.md for one small change (run tests + lint + PR notes).

How to Use It Well

• Setup time ~10 minutes (write a minimal AGENTS.md and iterate)
• One file, repo-root convention: reduces repeated “how do I run tests here?” prompts across tasks
• GitHub stars + forks (verified): see Source & Thanks

The point is predictability. A coding agent can only be reliable if it knows your exact build/test steps and how you expect PRs to look. Write those once, keep them versioned, and require agents to follow them.

FAQ

Q: Is AGENTS.md required? A: No. It’s an open convention. Use it when you want consistent, tool-agnostic agent guidance.

Q: What should I put in it first? A: Start with install/test/lint commands and any repo-specific gotchas (monorepo filters, env vars).

Q: Does it replace README? A: No. Treat it as an agent-focused companion: tighter, action-oriented, and focused on dev workflows.