OpenAI Codex 中文文档(4.14更新)
联系我
官方文档

在 GitHub 中使用 Codex

在拉取请求中运行 Codex 代码评审

你可以直接在 GitHub 中使用 Codex 做拉取请求评审,无需离开 GitHub。只要在拉取请求评论中添加 @codex review,Codex 就会像标准 GitHub 代码评审一样返回评审结果。

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

设置代码评审

  1. 先配置好 Codex Web
  2. 打开 Codex 设置,启用 Code review(代码评审)

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

请求一次评审

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

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

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

Codex 会像队友一样,直接在拉取请求上发布一条评审。

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

启用自动评审

如果你希望 Codex 自动评审每一个拉取请求,请在 Codex 设置 中启用 Automatic reviews(自动评审)。这样每当新的 PR 被标记为 ready for review(可供评审) 时,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

在 GitHub 中,Codex 默认只标记 P0 和 P1 级问题。如果你希望它连文档中的错别字也标出来,可以在 AGENTS.md 中补充指导,例如:“Treat typos in docs as P1.”

给 Codex 其他任务

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

@codex fix the CI failures

来源:https://developers.openai.com/codex/integrations/github