Using Codex

集成

官方集成包括 GitHub、Slack、Linear 等工程协作入口。

使用 Codex code review,可以在 GitHub pull requests 上获得另一轮高信号 review。Codex 会审查 pull request diff,遵循你的 repository guidance,并发布一个标准 GitHub code review,重点关注严重问题。

开始之前

已经为你想 review 的 repository 设置好 Codex cloud

可以访问 Codex code review settings。

如果希望 Codex 遵循 repository-specific review guidance,需要准备 AGENTS.md 文件。

设置 Codex code review

Codex settings showing the Code 检查 切换

设置 Codex cloud

前往 Codex settings

为你的 repository 打开 Code review。

请求 Codex review

A pull request comment 使用 @codex review

在 pull request comment 中 mention @codex review。

等待 Codex 做出反应(眼睛标记)并发布 review。

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

Example Codex code 检查 on a pull request

启用 automatic reviews

如果希望 Codex 自动 review 每个 pull request,请在 Codex settings 中打开 Automatic reviews。之后,只要有人打开新的 PR 请求 review,Codex 就会发布 review,不再需要 @codex review comment。

自定义 Codex review 的内容

Codex 会在你的 repository 中搜索 AGENTS.md 文件,并遵循其中包含的任何 Review guidelines。

要为 repository 设置 guidelines,请添加或更新顶层 AGENTS.md,并加入类似这样的 section:

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

Codex 会把距离每个 changed file 最近的 AGENTS.md 中的 guidance 应用到该文件。需要对特定 package 做额外审查时,可以在目录树更深处放置更具体的 instructions。

如果只想对一次 review 指定重点,请把要求加到 pull request comment 中:

@codex review for security regressions

如果希望 Codex 标记 documentation 中的 typos,请在 AGENTS.md 中添加 guidance,例如 “Treat typos in docs as P1.”。

处理 review findings

Codex 发布 review 后,你可以再留一条 comment,让它在同一个 pull request 中修复问题:

@codex fix the P1 issue

Codex 会以该 pull request 作为 context 启动 cloud task,并在有权限时把 fix push 回该 branch。

交给 Codex 其他任务

如果你在 comment 中 mention @codex,但内容不是 review,Codex 会使用你的 pull request 作为 context 启动一个 cloud task

@codex fix the CI failures

排查 code review 问题

如果 Codex 没有反应或没有发布 review:

确认你已经在 Codex settings 中为该 repository 打开 Code review。

确认该 pull request 属于已经设置 Codex cloud 的 repository。

在 pull request comment 中使用准确触发语 @codex review。

对于 automatic reviews,请检查你已经打开 Automatic reviews,并且 pull request event 符合你的 review trigger settings。

站内延伸阅读

相关专题