跳到主要内容

本文为非官方中文翻译,内容以 OpenAI 官方英文文档为准。
官方来源:https://developers.openai.com/codex/integrations/github

GitHub 中的 Codex 代码审查

为 GitHub pull request 设置 Codex 代码审查,使用 @codex review 请求审查,启用自动审查,并自定义审查指南。

使用 Codex 代码审查,为 GitHub pull request 增加一次高信号的额外审查。Codex 会审查 pull request 的 diff,遵循你的代码库指南,并发布一条聚焦于严重问题的标准 GitHub 代码审查。

Codex 代码审查演练

Codex 代码审查演练

开始之前

请确保你已具备:

  • 已为你想要审查的代码库设置好 Codex cloud
  • 拥有 Codex code review settings 的访问权限。
  • 如果你希望 Codex 遵循代码库特定的审查指南,请准备一个 AGENTS.md 文件。

设置 Codex 代码审查

  1. 设置 Codex cloud
  2. 前往 Codex settings
  3. 为你的代码库打开 Code review

显示 Code review 开关的 Codex settings

请求一次 Codex 审查

  1. 在 pull request 评论中提及 @codex review
  2. 等待 Codex 作出反应(👀)并发布审查。

包含 @codex review 的 pull request 评论

Codex 会像团队成员一样在 pull request 上发布审查。在 GitHub 中,Codex 只会标记 P0 和 P1 问题,以便让审查评论聚焦于高优先级风险。

pull request 上的 Codex 代码审查示例

启用自动审查

如果你希望 Codex 自动审查每一个 pull request,请在 Codex settings 中打开 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 中添加相关指南(例如,“Treat typos in docs as P1.”)。

根据审查结果采取行动

在 Codex 发布审查后,你可以通过在同一个 pull request 中再留下一条评论,让它修复问题:

@codex fix the P1 issue

Codex 会以该 pull request 作为上下文启动一个 cloud task,并且在有权限的情况下,可以将修复推送回该分支。

给 Codex 分配其他任务

如果你在评论中提及 @codex,但内容不是 review,Codex 会使用你的 pull request 作为上下文启动一个 cloud task

@codex fix the CI failures

代码审查故障排查

如果 Codex 没有作出反应或发布审查:

  • 确认你已在 Codex settings 中为该代码库打开 Code review
  • 确认该 pull request 属于一个已设置好 Codex cloud 的代码库。
  • 在 pull request 评论中使用精确触发词 @codex review
  • 对于自动审查,请检查你是否已打开 Automatic reviews,并确认 pull request 事件与你的审查触发设置相匹配。