English
主导航
Codex

Codex 用例

审查 GitHub 拉取请求

在人工审查之前捕获回归和潜在问题。

难度 简单
时间周期 5s

使用 GitHub 中的 Codex 代码审查,直接在拉取请求中自动暴露回归、缺失测试和文档问题。

适用场景

  • 希望在人工批准合并前获得额外审查信号的团队
  • 投入生产的大型项目代码库

目录

    ← 所有用例

    审查 GitHub 拉取请求

    在人工审查之前捕获回归和潜在问题。

    使用 GitHub 中的 Codex 代码审查,直接在拉取请求中自动暴露回归、缺失测试和文档问题。

    简单
    5s

    使用 GitHub 中的 Codex 代码审查,直接在拉取请求中自动暴露回归、缺失测试和文档问题。

    简单
    5s

    适用场景

    • 希望在人工批准合并前获得额外审查信号的团队
    • 投入生产的大型项目代码库

    技能与插件

    • 将审查重点放在机密信息、身份验证和依赖项变更等高风险方面。
    技能 为什么使用它
    安全最佳实践 将审查重点放在机密信息、身份验证和依赖项变更等高风险方面。

    起始提示词

    @codex 审查是否存在安全回归、缺失测试和有风险的行为变更。
    @codex 审查是否存在安全回归、缺失测试和有风险的行为变更。

    如何使用

    首先,将 Codex 代码审查添加到你的 GitHub 组织或仓库中。参见 GitHub 中的 Codex 代码审查 for more details.

    你可以将 Codex 配置为自动审查每个拉取请求,或者通过以下方式请求审查 @codex review 在拉取请求评论中。

    如果 Codex 标记了回归或潜在问题,你可以在拉取请求中发表评论,并附带后续提示(例如)来要求它修复 @codex fix it.

    这将启动一个新的云端任务来修复该问题并更新拉取请求。

    定义审查指南

    要自定义 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 中的指导原则应用于该文件。当特定软件包需要额外审查时,你可以在目录树的更深层级放置更具体的指令。

    相关用例