Skip to main content
您可以通过向仓库提交指令来更改 Code Review 在该仓库上标记的内容。借此可以减少吹毛求疵类评论的数量、停止对生成文件发表评论，或添加团队关注的规则。请将这些指令放在以下两个文件之一中：
  • CLAUDE.md：Claude Code 在执行每项任务（包括审查）时都会读取的项目指令。Code Review 将其作为项目上下文读取，并标记违反这些指令的更改。
  • REVIEW.md：仅用于审查的指令。使用它来说明您的团队希望标记哪些内容、以何种严重程度标记，以及要跳过哪些内容。
在仓库根目录添加 REVIEW.md 并将其合并。然后保护您的默认分支。
如需更改审查的详尽程度或运行时机，请让 Owner 更改审查级别或 Review runs 设置。

​
使用 CLAUDE.md 设置项目范围的规则

Code Review 将仓库中的 CLAUDE.md 文件作为项目上下文读取。违反其中某条规则的更改会成为一项发现，并按照与问题相符的严重程度级别进行标记。 审查会读取仓库根目录下的 CLAUDE.md，以及每个已更改文件的各级父目录中的 CLAUDE.md 文件。当 Pull Request 更改了某个子目录路径下的文件时，会读取该子目录中的 CLAUDE.md。

​
使用 REVIEW.md 设置仅用于审查的规则

REVIEW.md 是位于仓库根目录的文件，用于针对您的仓库定制 Code Review。您还可以在子目录中添加 REVIEW.md，在根文件的基础上为该路径下的更改添加检查项。 负责发现问题的 Agent 和负责验证问题的 Agent 会将其内容作为您仓库的审查指令接收，同时接收 Code Review 的默认审查指导。撰写最终审查的步骤会在确定严重程度和撰写摘要之前参考该文件。 以下示例布局包含一个根文件和一个子目录文件：
在依赖子目录文件之前，请先保护您的默认分支，并查看针对您的分支设置，审查会读取哪些内容。
Code Review 服务和本地 /code-review 命令是两个独立的工具，它们读取的文件不同。该服务会同时读取 CLAUDE.md 和 REVIEW.md。/code-review 命令在您自己机器上的 Claude Code 会话中运行，它读取您的 CLAUDE.md 文件，但不读取 REVIEW.md。请将希望在两处都生效的指导放在 CLAUDE.md 中，并将 REVIEW.md 留给 Pull Request 审查专用的规则。

​
REVIEW.md 示例

此 REVIEW.md 为一个后端服务重新校准了严重程度、限制了 nit 数量、跳过了生成文件，并添加了仓库特定的检查项。

​
选择在 REVIEW.md 中写入的内容

REVIEW.md 是格式自由的 Markdown，用于更改审查发现和报告的内容。它不会改变审查的格式。找到您遇到的问题，然后添加类似所示的指令。示例使用了前四项。
  • 错误的内容被标记为 Important：为您的仓库重新定义 🔴 Important 的含义。默认校准以生产代码为目标，而文档仓库、配置仓库或原型可能需要更窄的定义。说明哪些类别的发现属于 Important，哪些最多属于 Nit。您也可以提高级别，例如将任何违反 CLAUDE.md 的情况视为 Important。
  • nit 过多：限制单次审查发布的 🟡 Nit 评论数量。诸如“最多报告五个 nit”之类的上限可以让审查保持可操作性。
  • 对生成文件或 CI 已检查的内容发表评论：列出 Claude 应跳过发现的路径和发现类别。常见的候选项包括生成的代码、锁文件和 vendored 依赖，以及 CI 已强制执行的任何内容，如 lint 或拼写检查。对于值得一定程度审查但无需全面审视的路径，可改为设置更高的门槛：“在 scripts/ 中，仅在几乎确定且严重时才报告。”
  • 某条团队规则未被检查：添加您希望在每个 Pull Request 上标记的规则，例如“新的 API 路由必须有集成测试”。
  • 事后证明有误的发现：要求某类发现在发布前提供证据。例如，“关于行为的断言需要在源代码中引用 file:line，而不是根据命名进行推断”，这可以减少误报，否则作者需要为此额外往返一次。
其中一些指令需要根文件位于受保护的默认分支上。 REVIEW.md 中只保留会改变审查行为的指令，并将一般项目上下文留在 CLAUDE.md 中。

​
从哪个分支读取 REVIEW.md

Code Review 从 Pull Request 的基础分支或默认分支读取 REVIEW.md，从不从 Pull Request 自身的更改中读取。如需更改审查行为，请先合并对 REVIEW.md 的更改。 请将 REVIEW.md 保留在默认分支上，并保护该分支。当审查读取受保护默认分支上的副本时（即下表第一行的情况），它会遵循根文件中的以下指令：
  • 降低某项发现的严重程度
  • 排除路径、文件或问题类别
  • 限制 nit 评论数量

​
哪些设置算作分支保护

Code Review 将以下设置视为保护：
  • 默认分支：经典分支保护规则或规则集
  • 任何其他分支：仅限规则集
当规则集限制更新，或要求 Pull Request 获得至少一次审批时，该规则集才算作保护。如果它要求 Pull Request，则还必须在有新推送时撤销该审批，或要求审批发生在最后一次推送之后。

​
针对每种分支设置，审查会读取哪些内容

在下表第一列中找到您仓库的情况。 如果检查运行中提到了 REVIEW.md，请参阅检查运行中提到 REVIEW.md。