Codex 代码审查技巧:本地 /review、GitHub 里 @codex 和自动审查
Codex 能在本地审查未提交的改动,也能在 GitHub 拉取请求里自动留审查意见。本文按官方文档讲 /review 的四种审查范围、@codex review 和自动审查的开法、用 AGENTS.md 写团队审查规则,以及审查后让 Codex 动手修。
写完代码,最好有人先帮你看一遍再合并。Codex 能做这件事:在本地审查还没提交的改动,也能在 GitHub 的拉取请求(PR)里自动留审查意见。本文按 OpenAI 官方文档,讲清楚三种审查方式怎么用、怎么让审查按你团队的规则来,以及审查之后怎么让 Codex 帮你修。
方式一:本地用 /review 审查
在桌面应用、命令行或编辑器插件的输入框里输入 /review 即可。注意:项目必须是一个 Git 仓库,否则这个命令不会出现。
官方文档列出的审查范围有四种:
- 对比基础分支(Review against a base branch):自动找到分叉点,审查你这个分支的全部改动,适合提 PR 之前自查。
- 检查未提交的改动(Review uncommitted changes):包括已暂存、未暂存和新建的文件,适合改到一半时检查。
- 审查某次提交(Review a commit):只看选中的那一次提交。
- 自定义审查要求(Custom review instructions):告诉它重点看什么,例如「只看并发和锁的问题」。
审查结果按优先级列出问题,不会改动你的工作区。如果你接着让 Codex 去修,这时才会按你平时的沙箱和审批设置执行。
两个相关设置:
- 审查默认在当前对话里进行。想另开一个审查对话,桌面应用在 Settings > General > Code review 里选 Detached;编辑器插件把
chatgpt.reviewDelivery设为detached。 - 想让审查用另一个模型,在
config.toml里设置review_model。
方式二:在 GitHub 拉取请求里 @codex
先把 GitHub 仓库连接到 Codex,再打开 Codex 的审查设置页(chatgpt.com/settings/code-review)选中这个仓库。之后,在任意一个 PR 的评论里写:
@codex review
Codex 会先回一个 👀 表情,然后发出审查意见。官方说明,在 GitHub 上 Codex 只标出 P0 和 P1 两个级别的问题,也就是只提重要的,不会用一堆细枝末节刷屏。
方式三:开启自动审查
不想每次手动 @,可以打开自动审查:
- 给整个仓库开:在 Review code 下打开 Automatic review;
- 只给自己的 PR 开:在 Personal preferences 下打开 Automatic review;
- 用 Review trigger 选择什么时候触发审查。
注意:修改自动审查设置,需要你对该仓库有 push 或管理员权限。云端审查不需要另外创建云端环境。
让审查按你的规则来
团队有自己的规范时,把规则写进 AGENTS.md:加一个 ## Code Review Rules 小节,下面用 ### 小标题给检查项分组,例如:
## Code Review Rules
### 安全
- 日志里不能输出用户的手机号和令牌
### 数据库
- 新增查询必须走已有的索引
全仓库通用的规则放在根目录的 AGENTS.md,某个服务专用的规则放在该服务目录下的 AGENTS.md。Codex 审查每个改动文件时,会同时套用根目录的规则和离这个文件最近的那份规则。
桌面应用里也可以点 Review with Codex 旁边的齿轮,填写审查要求(Review instructions)。
审查之后:让 Codex 动手修
在 PR 评论里直接 @codex 提要求,例如:
@codex fix the P1 issue
@codex fix the CI failures
除了 review 以外的 @codex 评论,都会以这个 PR 为上下文开启一个云端任务;有权限时,Codex 能把修复直接推送到该分支。
另外还有一个研究预览功能:评论 @codex security review 可以单独发起一次安全审查,完整报告在对应 Codex 任务的 Security Report 标签页里查看。
上手建议
建议先从本地开始:每次提交前跑一次 /review 选「检查未提交的改动」,习惯之后再给仓库打开自动审查,并在 AGENTS.md 里写上三五条团队最在意的规则。团队里多人频繁提 PR、审查量大的,可以在 BuyBuy代充(buybuytopup.cn) 开通 ChatGPT Pro,用量更宽裕,具体额度以官方页面为准。