Skip to content

验证与 Review 闭环

14.1 核心理念:不止写代码,还要验证代码

Section titled “14.1 核心理念:不止写代码,还要验证代码”

官方 best practices 强调:

Don’t stop at asking Codex to make a change. Ask it to create tests when needed, run the relevant checks, confirm the result, and review the work before you accept it.

很多人用 Codex 的流程停在“代码写出来了”。但在工程里,真正的完成应该是:

  • 测试补了没有
  • 相关测试跑了没有
  • lint / format / type check 过了没有
  • diff 有没有异常
  • 有没有引入回归
  • 最终行为是否符合需求

把验证要求直接写进任务 prompt:

实现后请运行相关测试,并检查 git diff,确认没有无关修改。
如果测试无法运行,请说明原因和你已经做过的验证。

完整的验证清单:

验证方式
测试补充 新代码有对应测试
测试通过 跑了相关测试套件
lint pnpm lint 无报错
format pnpm format 无变更
type check pnpm typecheck 通过
diff git diff 无无关修改
回归 没有破坏现有功能
行为 最终行为符合需求

用得好时,Codex 不只是生成代码,还能:

  • 补测试
  • 跑测试
  • 看日志
  • review diff
  • 找潜在回归
  • 根据 checklist 做 PR review

/review 是验证闭环的核心命令,提供四种模式:

/review
模式 作用
Review against a base branch 对基线分支做 PR 式审查(适合提交前)
Review uncommitted changes 审查未提交的修改
Review a commit 审查某个具体 commit
Custom review instructions 用自定义规则审查

团队想让 review 行为跨仓库、跨贡献者保持一致,推荐模式:

  1. 在仓库根目录建 code_review.md,写明 review 规则
  2. AGENTS.md 中引用:
AGENTS.md
## 代码审查
审查时遵循 [code_review.md](./code_review.md) 的规则。

这样 Codex 做 /review 时会自动按团队规则审查。

# Code Review Checklist
## 必查项
- [ ] 命名清晰,符合团队规范
- [ ] 单一职责,函数/类不过长
- [ ] 无明显副作用
- [ ] 错误处理完整(不吞异常)
- [ ] 无硬编码密钥/密码
- [ ] 无 SQL 注入、XSS 等安全风险
## 测试
- [ ] 新代码有测试
- [ ] 边界条件覆盖
- [ ] 测试通过
## 性能
- [ ] 无 N+1 查询
- [ ] 无不必要的全量加载
- [ ] 大数据量场景考虑分页
## 可维护性
- [ ] 复杂逻辑有注释
- [ ] 公开 API 有文档
- [ ] 无重复代码

在 Codex App 中,可以打开 diff 面板直接 review 本地修改:

  1. 切换到 diff 视图
  2. 点击某一行,给反馈
  3. 反馈会作为 context 传给 Codex 的下一轮

这是“人机协作 review”的直观方式。

如果用 GitHub Cloud,可以设置 Codex 为你的 PR 自动做 code review。

OpenAI 官方实践:Codex reviews 100% of PRs(OpenAI 内部所有 PR 都由 Codex review)。两种触发方式:

  • 自动 review:每次提 PR 自动触发
  • 响应式 review:用 @Codex 召唤

详见官方 GitHub 集成文档

完整的“写代码 → 验证”闭环:

1. 给 Codex 任务(含验证标准)
2. Codex 实现代码
3. Codex 补测试
4. Codex 跑测试 + lint + type check
5. Codex 检查 git diff
6. 你用 /review 审查
7. 你确认接受 / 给反馈
8. (团队场景)PR 提交,Codex 自动 review

关键:让 Codex 知道“什么是好的”——这个标准来自 prompt 或 AGENTS.md

  • OpenAI 官方 Codex best practices——验证闭环、/review、GitHub 集成
  • CSDN《Codex 使用最佳实践》——中文验证闭环解读
  • 官方 GitHub 集成文档——100% PR review
  • CSDN《Codex 完整指南(四)》——/review 四种模式