> ## Documentation Index
> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 自定义 Code Review

> 使用 REVIEW.md 和 CLAUDE.md 调整 Code Review 在您的 Pull Request 上标记的内容：重新校准严重程度、跳过路径、添加检查项，并查看适用的是哪个副本。

您可以通过向仓库提交指令来更改 [Code Review](/docs/zh-CN/code-review) 在该仓库上标记的内容。借此可以减少吹毛求疵类评论的数量、停止对生成文件发表评论，或添加团队关注的规则。请将这些指令放在以下两个文件之一中：

* **`CLAUDE.md`**：Claude Code 在执行每项任务（包括审查）时都会读取的[项目指令](/docs/zh-CN/memory)。Code Review 将其作为项目上下文读取，并标记违反这些指令的更改。
* **`REVIEW.md`**：仅用于审查的指令。使用它来说明您的团队希望标记哪些内容、以何种严重程度标记，以及要跳过哪些内容。

在仓库根目录添加 `REVIEW.md` 并将其合并。然后[保护您的默认分支](#which-branch-review-md-is-read-from)。

<Note>
  如需更改审查的详尽程度或运行时机，请让 Owner 更改[审查级别](/docs/zh-CN/code-review-setup#set-the-default-review-level)或 [**Review runs** 设置](/docs/zh-CN/code-review-setup#set-when-reviews-run)。
</Note>

<h2 id="use-claude-md-for-project-wide-rules">
  使用 CLAUDE.md 设置项目范围的规则
</h2>

Code Review 将仓库中的 `CLAUDE.md` 文件作为项目上下文读取。违反其中某条规则的更改会成为一项发现，并按照与问题相符的[严重程度级别](/docs/zh-CN/code-review-pull-requests#severity-levels)进行标记。

审查会读取仓库根目录下的 `CLAUDE.md`，以及每个已更改文件的各级父目录中的 `CLAUDE.md` 文件。当 Pull Request 更改了某个子目录路径下的文件时，会读取该子目录中的 `CLAUDE.md`。

<h2 id="use-review-md-for-review-only-rules">
  使用 REVIEW\.md 设置仅用于审查的规则
</h2>

`REVIEW.md` 是位于仓库根目录的文件，用于针对您的仓库定制 Code Review。您还可以在子目录中添加 `REVIEW.md`，在根文件的基础上为该路径下的更改添加检查项。

负责发现问题的 Agent 和负责验证问题的 Agent 会将其内容作为您仓库的审查指令接收，同时接收 Code Review 的默认审查指导。撰写最终审查的步骤会在确定严重程度和撰写摘要之前参考该文件。

以下示例布局包含一个根文件和一个子目录文件：

```text theme={null}
your-repo/
├── REVIEW.md            # Root file
├── services/
│   └── billing/
│       └── REVIEW.md    # Adds checks for changes under services/billing/
└── src/
```

在依赖子目录文件之前，请先保护您的默认分支，并查看[针对您的分支设置，审查会读取哪些内容](#what-a-review-reads-for-each-branch-setup)。

<Note>
  Code Review 服务和本地 [`/code-review` 命令](/docs/zh-CN/code-review-local)是两个独立的工具，它们读取的文件不同。该服务会同时读取 `CLAUDE.md` 和 `REVIEW.md`。`/code-review` 命令在您自己机器上的 Claude Code 会话中运行，它读取您的 `CLAUDE.md` 文件，但不读取 `REVIEW.md`。请将希望在两处都生效的指导放在 `CLAUDE.md` 中，并将 `REVIEW.md` 留给 Pull Request 审查专用的规则。
</Note>

<h3 id="example-review-md">
  REVIEW\.md 示例
</h3>

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

```markdown theme={null}
# Review instructions

## What Important means here

Reserve Important for findings that would break behavior, leak data,
or block a rollback: incorrect logic, unscoped database queries, PII
in logs or error messages, and migrations that aren't backward
compatible. Style, naming, and refactoring suggestions are Nit at
most.

## Cap the nits

Report at most five Nits per review.

## Do not report

- Anything CI already enforces: lint, formatting, type errors
- Generated files under `src/gen/` and any `*.lock` file
- Test-only code that intentionally violates production rules

## Always check

- New API routes have an integration test
- Log lines don't include email addresses, user IDs, or request bodies
- Database queries are scoped to the caller's tenant
```

<h3 id="choose-what-to-write-in-review-md">
  选择在 REVIEW\.md 中写入的内容
</h3>

`REVIEW.md` 是格式自由的 Markdown，用于更改审查发现和报告的内容。它不会改变审查的格式。找到您遇到的问题，然后添加类似所示的指令。[示例](#example-review-md)使用了前四项。

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

其中一些指令[需要根文件位于受保护的默认分支上](#which-branch-review-md-is-read-from)。

`REVIEW.md` 中只保留会改变审查行为的指令，并将一般项目上下文留在 `CLAUDE.md` 中。

<h3 id="which-branch-review-md-is-read-from">
  从哪个分支读取 REVIEW\.md
</h3>

Code Review 从 Pull Request 的基础分支或默认分支读取 `REVIEW.md`，从不从 Pull Request 自身的更改中读取。如需更改审查行为，请先合并对 `REVIEW.md` 的更改。

请将 `REVIEW.md` 保留在默认分支上，并保护该分支。当审查读取受保护默认分支上的副本时（即下表第一行的情况），它会遵循根文件中的以下指令：

* 降低某项发现的严重程度
* 排除路径、文件或问题类别
* 限制 nit 评论数量

<h4 id="what-counts-as-branch-protection">
  哪些设置算作分支保护
</h4>

Code Review 将以下设置视为保护：

* **默认分支**：经典分支保护规则或规则集
* **任何其他分支**：仅限规则集

当规则集限制更新，或要求 Pull Request 获得至少一次审批时，该规则集才算作保护。如果它要求 Pull Request，则还必须在有新推送时撤销该审批，或要求审批发生在最后一次推送之后。

<h4 id="what-a-review-reads-for-each-branch-setup">
  针对每种分支设置，审查会读取哪些内容
</h4>

在下表第一列中找到您仓库的情况。

| 分支保护 | 读取的副本 | 读取的文件 |
| :- | :- | :- |
| 默认分支受保护，且 Pull Request 以其为目标，或以未受任何规则集保护的分支为目标 | 默认分支 | 根文件和子目录文件 |
| Pull Request 以另一个受规则集保护的分支为目标 | 该基础分支 | 根文件和子目录文件 |
| 默认分支未受保护，且基础分支没有任何一种保护规则 | 默认分支 | 根文件 |
| Code Review 无法确认保护设置。这包括默认分支未受保护、而基础分支仅有经典规则的情况 | 无 | 无 |

如果检查运行中提到了 `REVIEW.md`，请参阅[检查运行中提到 REVIEW.md](/docs/zh-CN/code-review-troubleshooting#the-check-run-mentions-review-md)。

<h2 id="related-resources">
  相关资源
</h2>

* [Code Review](/docs/zh-CN/code-review)：该服务是什么以及审查如何运行
* [在 Pull Request 上阅读和请求审查](/docs/zh-CN/code-review-pull-requests#severity-levels)：每个严重程度级别的含义以及发现的呈现方式
* [设置 Code Review](/docs/zh-CN/code-review-setup)：由 Owner 设置的审查级别和审查运行时机
* [使用 `/code-review` 在本地审查](/docs/zh-CN/code-review-local)：`/code-review` 命令、其参数和 effort 级别
* [记忆](/docs/zh-CN/memory)：`CLAUDE.md` 文件在 Claude Code 中的工作方式