heydeer Sign in
Customize reviews

AGENTS.md

Keep your team’s coding conventions, test commands, and review priorities in AGENTS.md at the repository root. Add a nested AGENTS.md when a directory needs more specific guidance.

HeyDeer asks every reviewer, including the final verifier, to read AGENTS.md from the review’s base revision and follow the instructions for the files being reviewed. More specific directory guidance takes precedence. PR edits to these instructions apply after they reach the base branch.

# Review guidance

- Check that every database query is scoped to a workspace.
- Run pnpm test for changes to billing calculations.
- Keep public API responses backward-compatible.

Use AGENTS.md for shared guidance. Use repository checks for focused rules with individual passed, failed, or skipped results. Repository guidance cannot override configured review instructions or review safety rules.

Only using CLAUDE.md?

Move your shared instructions into AGENTS.md. If it already exists, merge the rules instead of overwriting it. Update any relative links when moving content between directories.

For older Claude Code versions or sessions without native AGENTS.md support, keep a CLAUDE.md beside it containing this import. Maintain the rules in AGENTS.md:

@AGENTS.md

Using Claude Code locally

Claude Code 2.1.277+ reads AGENTS.md by default when no CLAUDE.md or CLAUDE.local.md is found in the current directory or its parents. Update with claude update and restart. An import-only CLAUDE.md can then be removed.

To load both formats, choose claude-md-and-agents-md under /config → Project instructions. This preference belongs in user settings; project and local settings cannot set it.

Native support requires the built-in plugin and feature flags. It can be unavailable with hooks or telemetry disabled, third-party providers, or the first session after upgrading. Use the import above in those cases.

Claude Code’s AGENTS.md documentation →