加载中

AI 在 PR 审查循环中的应用

第 10 课5 分钟

Claude 既给出审查,也接受审查。它根据组织的政策审查传入的 PR,并处理自己 PR 上的审查意见。这使工程师能够专注于 PR 审查中的行为判断,归根结底就是判断意图和风险。

发生了什么变化

传统方式AI 原生方式
审查能力是围绕人工产出来规划的。一个 PR 要等待审查者读完全部内容,审查质量随审查者的工作负荷而变化,作者不断催促,而积压的工作却在增加。所有 PR 都会经过一套相同的审查流程,发现的问题按严重程度排序。人类的关注点上升了一个层次,转向变更是否实现了计划的意图,以及风险是否可以接受。

入门指南

  • 前提条件:来自阶段 3:构建的最新 CLAUDE.md 文件、技能(如果审查流程要强制执行书面政策的话),以及已定义的子代理。
  • 基础设施:一个已安装 Claude 集成的代码仓库,可以是由您的 Claude 组织的所有者启用的托管代码审查服务,也可以是在您自己的 CI 中运行的 claude-code-action,并在需要时通过 Amazon Bedrock、Google Cloud 的 Vertex AI 或 Microsoft Foundry 进行模型调用(CI/CD 实践涵盖了部署选项)。要求代码所有者批准的分支保护策略也是值得设置的。

如何执行

  1. 托管的代码审查服务是最快的起点。您的 Claude 组织的所有者启用该服务并选择仓库。当您需要控制流水线,或希望 API 调用通过您自己的云服务协议路由时,可以使用 claude-code-action 在您自己的 CI 中运行审查(CI/CD 实践涵盖了相关的配置细节)。
  2. 技术负责人在仓库根目录编写审查政策 REVIEW.md,按组织关心的审查流程划分:缺陷和逻辑错误;安全性和漏洞;针对规范(来自需求实践的 spec.md)、实施计划(来自计划模式实践的 plan.md)以及设计原则的合规性。REVIEW.md 还定义了什么算作"重要"而不是"小问题",以及哪些内容应该跳过。
  3. 技术负责人设定人工介入的阈值。发现的问题本身不会批准或阻止 PR,分支保护仍然要求代码所有者批准。希望根据发现的问题来限制合并的平台工程师,可以读取检查运行发布的严重程度计数,这是一份机器可读的统计数据。
  4. 当审查者或作者在审查意见中标记 @claude 时,Claude 会处理该意见并推送修复。PR 讨论串会同时记录请求和变更。这个修复循环通过 claude-code-action 运行。在托管服务中,评论 @claude review 会请求一次全新的审查。对于 Claude 打开的 PR,可以更进一步,让 Claude 负责照看该 PR 直到合并。团队会将这个循环封装在一个自定义斜杠命令中,该命令会扫描 PR 上未解决的审查意见和失败的检查,处理它们并推送修复,直到 PR 变为绿色,只等待代码所有者的批准。
  5. 审查发现的问题会反馈到 CLAUDE.md 中。当某个审查第二次标记出同一个错误时,该修正会作为该次审查的一部分写入 CLAUDE.md,并且由于审查会读取 CLAUDE.md,从下一个 PR 开始就能捕获到这个错误。审查还会标记出某项变更是否已使 CLAUDE.md 过时。
  6. 技术负责人每月对设置进行一次调优,通过对发现的问题进行评分来改进审查者,并在 REVIEW.md 中限制"小问题"的数量。生成的路径以及 CI 已经强制执行的内容会被排除在外。

实际效果是什么样的

REVIEW.md:

markdown
# Review instructions
## Passes
Run three passes and tag each finding with its pass:
- Bugs: logic errors, broken edge cases, subtle regressions
- Security: injection risks, authentication gaps, PII in logs
- Compliance: the change matches spec.md, plan.md and our design principles
## What Important means here
Reserve Important for findings that would break behavior, leak data
or breach a policy. Style and naming are nits.
## Cap the nits
Report at most five nits per review; summarize the rest as a count.
## Do not report
Generated files under src/gen/ and anything CI already enforces.

以下示例是检查运行针对一个为保险公司客户门户添加理赔状态面板的拉取请求所列出的内容,其中 claims-core 是该门户后端背后较旧的内部系统:

严重程度文件:行号问题
重要portal/src/claims/StatusPanel.tsx:22合规性:该面板在每次渲染时都会发起请求。plan.md 规定必须进行缓存,因为 claims-core 每秒只允许 50 个请求
重要claims-api/routes/status.py:31安全性:错误处理路径记录了整个 claims-core 响应,其中包含 policy_holder_name
小问题claims-api/tests/test_status.py:8缺陷:没有测试覆盖没有预期日期的 paid 理赔情况

第一个发现之所以存在,仅仅是因为合规性审查流程读取了已提交的 plan.md,而仅查看差异的审查者是不会打开这个文件的。

治理考量

职责分离得以保留,因为编写代码的代理无法批准自己的代码。REVIEW.md 中的审查政策适用于所有 PR,发现的问题、修复、评分和批准都记录在 PR 历史中,因此 PR 本身就是审计记录。批准来自人类,通过分支保护机制,并以发现的问题为依据。

如何衡量

  • 领先指标:首次审查所需时间,该时间应降至几分钟,以及在没有人工接触分支的情况下得到解决的审查意见占比,数据直接存储在 Git 上。
  • 滞后指标:合并前捕获的缺陷和漏洞数量,与流入生产环境的缺陷和漏洞数量相对比,数据来自 PR 历史和事件跟踪系统。