[MD.SAVE]by PackWink

AGENTS.MD GUIDE

Write an AGENTS.md that coding agents can follow

Prioritize commands, scope, constraints, and completion criteria over a long project introduction.

Recommended structure

  1. Briefly describe the repository purpose and important directories.
  2. Provide exact install, development, test, lint, and build commands.
  3. Separate coding conventions from files or data that must not be changed.
  4. Define the checks and report required before a task is complete.

Reduce ambiguity

  • Prefer “run `npm test` and `npm run lint`” over “test carefully.”
  • Name the path when rules differ by subdirectory.
  • Give secrets, production data, and deployment authority their own explicit boundary.

Separate root and subtree rules

Keep repository-wide commands and constraints in the root AGENTS.md. When the website and extension have different checks, put narrower rules in the closest subtree instead of copying every command into every file.

Turn intentions into observable rules

  • Replace “consider mobile” with “check overflow and CTAs at 390px.”
  • Name the files and source of truth behind “update the docs.”
  • State the writable repository path instead of “do not touch other code.”
  • Include a real URL or artifact check when commands alone cannot prove completion.

Open the AGENTS.md template

Open the Korean or English AGENTS.md in the AI document templates, then replace example commands and completion criteria with repository facts.

Read next