审查 GitHub pull request | Codex 使用场景

概览

在 GitHub 中使用 Codex 代码审查，自动直接在 pull request 上发现回归、缺失的测试和文档问题。

适合场景

希望在人类批准合并前增加一个审查信号的团队
已投入生产的项目的大型代码库

让 Codex 审查一个 pull request

@codex 审查安全回归、缺失测试以及有风险的行为变更。

使用方法

首先，将 Codex 代码审查添加到你的 GitHub 组织或仓库中。更多详情请参见 GitHub 中的 Codex 代码审查。

你可以将 Codex 设置为自动审查每个 pull request，或者在 pull request 评论中使用 @codex review 请求审查。

如果 Codex 标记出回归或潜在问题，你可以通过在 pull request 上使用类似 @codex fix it 的后续提示词发表评论，让它修复问题。

这将启动一个新的云端任务来修复该问题并更新 pull request。

定义审查指南

要自定义 Codex 审查的内容，请添加或更新顶层 AGENTS.md，加入如下所示的章节：

## Review guidelines

- Flag typos and grammar issues as P0 issues.
- Flag potential missing documentation as P1 issues.
- Flag missing tests as P1 issues.
  ...

Codex 会根据每个变更文件最近的 AGENTS.md 应用相应指南。当某些特定包需要额外审查时，你可以在目录树更深层的位置放置更具体的说明。