使用 Codex 代码审查,为您的 GitHub Pull Request 获取额外的高质量审查。Codex 会审查 Pull Request 的差异内容(diff),遵循您的仓库指南,并发布专注于严重问题的标准 GitHub 代码审查。
开始之前
确保您已完成以下准备:
- 为您想要审查的仓库配置好 Codex 云端。
- 拥有对 Codex 代码审查设置 的访问权限。
- 如果希望 Codex 遵循特定于仓库的审查指南,请准备一个
AGENTS.md文件。
设置 Codex 代码审查

请求 Codex 审查
- 在 Pull Request 的评论中,提及
@codex review。 - 等待 Codex 做出反应 (👀) 并发布审查结果。

Codex 会像团队成员一样在 Pull Request 上发布审查。在 GitHub 中,Codex 仅标记 P0 和 P1 级别的问题,以确保审查评论专注于高优先级风险。

启用自动审查
如果您希望 Codex 自动审查每个 Pull Request,请在 Codex 设置 中开启 自动审查(Automatic reviews)。每当有人创建新的 PR 请求审查时,Codex 都会自动发布审查,无需添加 @codex review 评论。
自定义 Codex 的审查内容
Codex 会搜索您仓库中的 AGENTS.md 文件,并遵循您包含的所有 审查准则(Review guidelines)。
要为仓库设置准则,请添加或更新顶层的 AGENTS.md,并包含类似以下的部分:
## Review guidelines
- Don't log PII.
- Verify that authentication middleware wraps every route.
Codex 会将来自最接近的 AGENTS.md 的指导应用于每个变更文件。您可以将更具体的指令放置在目录树的深层,以便在特定包需要额外审查时生效。
若需要一次性的重点审查,请将其添加到您的 Pull Request 评论中:
@codex review for security regressions
如果您希望 Codex 标记文档中的拼写错误,请在 AGENTS.md 中添加指导(例如:“将文档中的拼写错误视为 P1 级问题。”)。
处理审查结果
在 Codex 发布审查后,您可以通过发表另一条评论,要求它修复同一 Pull Request 中的问题:
@codex fix the P1 issue
Codex 会以该 Pull Request 为上下文启动云端任务,并在拥有权限时将修复推送回分支。
为 Codex 分配其他任务
如果在评论中提及 @codex 且内容非 review,Codex 将使用您的 Pull Request 作为上下文启动一个 云端任务。
@codex fix the CI failures
代码审查故障排除
如果 Codex 没有反应或没有发布审查: