REVIEW.md

写些什么

• 每个 PR 中都要检查的内容，例如数据库查询的范围是否正确限定。
• 哪些内容不必理会，例如 CI 已经会报告的问题。排除范围要窄，并写明适用的路径。
• 某类问题对你的团队有多严重，用 HeyDeer 的严重程度表示：严重、高、中、低。

REVIEW.md

# Review instructions

## Always check

- Database queries in src/api/ are scoped to the caller's
  workspace.
- Log lines don't include email addresses or request bodies.

## Leave alone

- Formatting and lint issues. CI enforces them.
- Code in tests/fixtures/ that breaks production rules on purpose.

## Severity

- A migration that isn't backward compatible is High.
- Naming and refactoring suggestions are Low.

编码约定请放在 AGENTS.md 中，这样编程智能体也会遵循。HeyDeer 必须在每个匹配的 PR 中核实的要求，请写成仓库检查。

根目录文件与嵌套文件

在仓库根目录添加 REVIEW.md。需要单独指导的目录可以有自己的文件，例如 src/payments/REVIEW.md。

REVIEW.md 作用于所在目录及其子目录中的改动。层级更深的文件是对上层文件的补充，两者冲突时以更深的文件为准。

由设置决定的内容

REVIEW.md 改变的是 HeyDeer 关注什么、问题有多严重，而不是 HeyDeer 的报告方式。报告方式请用设置调整：审查语言、反馈范围和自动批准。例如，想少发布一些严重程度为“低”的问题，请选择“精简”反馈范围。

REVIEW.md 不适用于仓库检查：匹配的检查总会运行，什么算违反检查只由检查本身决定。

要跳过生成文件，请改为在 .gitattributes 中标记它们，这样它们就不会进入审查。参见生成文件。

修改 REVIEW.md 的 PR

HeyDeer 从 PR 中读取 REVIEW.md，所以修改了它的 PR 会按 PR 里的版本审查，而且 HeyDeer 从不自动批准这样的 PR。不能让 PR 更改的指导，请放在审查指令中。

从 Claude Code Review 迁移

现有的 REVIEW.md 可以直接使用。仍有以下区别：

• HeyDeer 从 PR 中读取 REVIEW.md，而 Claude Code Review 从目标分支读取。
• Important 对应严重程度“中”及以上，Nit 对应“低”。
• 对 Nit 数量的上限不会生效。请改为选择“精简”反馈范围。
• HeyDeer 不展开 @review-security.md 这样的引用。请把被引用文件里的指导移到 REVIEW.md 中。