GitHub 中的 Codex 代码审查
使用 Codex 代码审查,在 GitHub 拉取请求中获得另一轮高质量审查。Codex 会审查拉取请求差异,遵循你的代码仓库指南,并发布一份标准的 GitHub 代码审查,重点关注严重问题。
请确保你具备以下条件:
- 已为要审查的代码仓库设置 Codex cloud。
- 可以访问 Codex 代码审查设置。
- 如果希望 Codex 遵循代码仓库特定的审查指南,请准备一个
AGENTS.md文件。
设置 Codex 代码审查
Section titled “设置 Codex 代码审查”- 设置 Codex cloud。
- 前往 Codex 设置。
- 为你的代码仓库开启 Code review。

请求 Codex 审查
Section titled “请求 Codex 审查”- 在拉取请求评论中提及
@codex review。 - 等待 Codex 做出反应(👀)并发布审查结果。

Codex 会像团队成员一样在拉取请求上发布审查结果。在 GitHub 中,Codex 只会标记 P0 和 P1 问题,让审查评论集中关注高优先级风险。

启用自动审查
Section titled “启用自动审查”如果希望 Codex 自动审查每个拉取请求,请在 Codex 设置中开启 Automatic reviews。每当有人打开新的拉取请求进行审查时,Codex 都会发布审查结果,无需添加 @codex review 评论。
自定义 Codex 的审查内容
Section titled “自定义 Codex 的审查内容”Codex 会在代码仓库中搜索 AGENTS.md 文件,并遵循适用的代码审查规则。在距离相关代码最近的文件中添加 ## Code Review Rules 部分。如有需要,可以使用 ### 标题对相关检查进行分组。
例如,实验报告服务可以确保曝光后的行为不会改变对照队列:
## Code Review Rules
### Experiment cohorts
- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention. Safe path: build cohorts from assignment or exposure; report conversion as an outcome.将代码仓库范围的规则放在根目录的 AGENTS.md 中,将服务特定的规则放在嵌套文件中,例如 services/experiment_reporting/AGENTS.md。Codex 会针对每个发生变更的文件,应用根目录指南和涵盖该文件的更具体指南,因此无关的变更无需携带服务特定的上下文。
先从两到三条简洁规则开始,编码记录审查者经常解释的检查项。实用的规则包括:
- 关注重要且特定于代码仓库的行为。 描述需要标记的兼容性约束、数据边界或不安全副作用,并说明其重要性。
- 说明安全路径或例外情况。 为 Codex 提供足够的上下文,以便区分实际问题与预期行为。
- 保持规则范围明确且持久有效。 优先描述结果,而不是可能发生变化的函数名称,并将指南放在靠近其适用代码的位置。
- 将机械检查留给 CI。 将格式化、lint 和其他确定性检查排除在审查规则之外。
打开一个有代表性的拉取请求,并使用 @codex review 请求审查。根据你看到的发现和反馈完善规则,并缩小或移除会产生噪声的指南。
代码审查规则用于指导 Codex;它们不能替代测试、分支保护或必需的批准。
如果想针对某个具体方面进行一次性审查,请将其添加到拉取请求评论中:
@codex review for security regressions
处理审查结果
Section titled “处理审查结果”Codex 发布审查结果后,你可以在同一个拉取请求中留下另一条评论,请求它修复问题:
@codex fix the P1 issueCodex 会以拉取请求为上下文开始云端聊天;获得相应权限后,它可以将修复推送回该分支。
让 Codex 执行其他任务
Section titled “让 Codex 执行其他任务”如果你在评论中提及 @codex,且内容不是 review,Codex 会使用你的拉取请求作为上下文,开始一次云端聊天。
@codex fix the CI failures排查代码审查问题
Section titled “排查代码审查问题”如果 Codex 没有反应或发布审查结果:
- 确认你已在代码仓库对应的 Codex 设置中开启 Code review。
- 确认该拉取请求属于已设置 Codex cloud 的代码仓库。
- 在拉取请求评论中使用确切的触发语句
@codex review。 - 对于自动审查,请检查你已开启 Automatic reviews,并确认拉取请求事件符合你的审查触发设置。