OpenAI Codex 中文教程

GitHub 中的 Codex 代码评审

让 Codex 为 GitHub 拉取请求再做一次高信号评审。

Codex 代码评审会检查拉取请求 diff,遵循仓库中的指导,并发布一条标准 GitHub 代码评审,重点关注严重问题。

概览视频:Codex 代码评审演示

开始之前

请先确认:

设置 Codex 代码评审

  1. 先配置好 Codex 云端
  2. 打开 Codex 设置
  3. 为你的仓库启用 Code review(代码评审)

显示 Code review(代码评审)开关的 Codex 设置页面

请求一次 Codex 评审

  1. 在拉取请求评论中输入:

    @codex review
  2. 等待 Codex 先做出 👀 反应,然后发布评审结果。

包含 @codex review 的拉取请求评论

Codex 会像队友一样,直接在拉取请求上发布一条评审。在 GitHub 中,Codex 只标记 P0 和 P1 级问题,因此评审评论会聚焦高优先级风险。

Codex 在拉取请求上发布的评审示例

启用自动评审

如果你希望 Codex 自动评审每一个拉取请求,请在 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 指导。如果某个 package 需要额外关注,你也可以把更具体的指令放到更深层目录里。

如果只是一次性的评审重点,可以直接写在拉取请求评论里:

@codex review for security regressions

如果你希望 Codex 标记文档中的错别字,可以在 AGENTS.md 中补充指导,例如:“Treat typos in docs as P1.”

处理评审发现

Codex 发布评审后,你可以继续在同一个拉取请求中留言,让它修复问题:

@codex fix the P1 issue

Codex 会以该拉取请求为上下文启动一个云端任务;如果它有权限,也可以把修复推回到当前分支。

给 Codex 其他任务

如果你在评论里提到 @codex,但后面跟的不是 review,Codex 就会使用当前拉取请求作为上下文,发起一个云端任务

@codex fix the CI failures

排查代码评审

如果 Codex 没有反应或没有发布评审:

  • 确认你已经在 Codex 设置中为该仓库启用 Code review(代码评审)
  • 确认该拉取请求属于已经配置 Codex 云端的仓库。
  • 在拉取请求评论中使用精确触发词 @codex review
  • 对于自动评审,确认你已经启用 Automatic reviews(自动评审),并且拉取请求事件匹配你的评审触发设置。