English
主导航

GitHub 中的 Codex 代码审查

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

使用 Codex 代码审查,为 GitHub 拉取请求获取额外的高价值审查。Codex 会审查拉取请求的差异,遵循您的仓库指南,并发布专注于严重问题的标准 GitHub 代码审查。


准备工作

请确保您已:

  • Codex 云端 已为您要审查的仓库设置好。
  • 有权访问 Codex 代码审查设置.
  • An AGENTS.md 文件(如果您希望 Codex 遵循特定于仓库的审查指南)。

设置 Codex 代码审查

  1. 设置 Codex 云端.
  2. Go to Codex 设置.
  3. 开启 代码审查 for your repository.
Codex settings showing the Code review toggle

请求 Codex 审查

  1. 在拉取请求评论中,提及 @codex review.
  2. 等待 Codex 反应(👀)并发布审查。
A pull request comment with @codex review

Codex 会在拉取请求上发布审查,就像团队成员一样。在 GitHub 中,Codex 仅标记 P0 和 P1 问题,以便让审查评论始终聚焦于高优先级风险。

Example Codex code review on a pull request

启用自动审查

如果你希望 Codex 自动审查每个拉取请求,请开启 自动审查 in Codex 设置。每当有人打开一个新 PR 进行审查时,Codex 就会发布一条审查,而无需 @codex review comment.

自定义 Codex 审查的内容

Codex 会在您的代码库中搜索 AGENTS.md 文件并遵循任何 Review guidelines 您包含的内容。

要为仓库设定指导方针,请添加或更新顶级 AGENTS.md ,并包含类似以下的部分:

## Review guidelines

- Don't log PII.
- Verify that authentication middleware wraps every route.

Codex 会将距离每个更改文件最近的 AGENTS.md 中的指导原则应用于该文件。当特定软件包需要额外审查时,你可以在目录树的更深层级放置更具体的指令。

若要进行一次性的重点提示,请将其添加到你的拉取请求评论中:

@codex review for security regressions

如果你希望 Codex 标记文档中的拼写错误,请在 AGENTS.md 中添加指导原则(例如,“将文档中的拼写错误视为 P1。”)。

处理审查发现的问题

在 Codex 发布审查后,你可以通过留下另一条评论,让它在同一个拉取请求中修复问题:

@codex fix the P1 issue

Codex 会启动一个云任务,并以该拉取请求作为上下文,当它拥有相应权限时,可以将修复推送到该分支。

向 Codex 分配其他任务

如果你提到 @codex 在评论中使用非 review,Codex 会启动一个 云端任务 使用你的拉取请求作为上下文。

@codex fix the CI failures

排查代码审查问题

如果 Codex 没有响应或未发布审查:

  • 确认你开启了 代码审查 for the repository in Codex 设置.
  • 确认拉取请求属于已 Codex 云端 设置的仓库。
  • 使用完全一致的触发 @codex review 在拉取请求评论中。
  • 对于自动审查,请检查你是否开启了 自动审查 并且拉取请求事件与你的审查触发设置相匹配。