For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主导航
Codex

Codex use case

审查 GitHub 中的 Pull Request

在人工审查前发现回归和潜在问题。

Difficulty 简单
Time horizon 5 秒

在 GitHub 中使用 Codex 代码审查,自动将回归、测试缺失和文档问题直接标在 Pull Request 上。

最适合

  • 希望在人工批准合并前获得额外审查信号的团队
  • 已在生产环境中运行的项目的大型代码库

Contents

    ← 全部使用场景

    审查 GitHub 中的 Pull Request

    在人工审查前发现回归和潜在问题。

    在 GitHub 中使用 Codex 代码审查,自动将回归、测试缺失和文档问题直接标在 Pull Request 上。

    简单
    5 秒

    在 GitHub 中使用 Codex 代码审查,自动将回归、测试缺失和文档问题直接标在 Pull Request 上。

    简单
    5 秒

    最适合

    • 希望在人工批准合并前获得额外审查信号的团队
    • 已在生产环境中运行的项目的大型代码库

    技能与插件

    Skill Why use it
    Security Best Practices 将审查重点放在机密信息、身份验证和依赖项变更等高风险领域。

    入门提示

    @codex 请审查是否存在安全性回归、测试缺失和可能带来风险的行为变更。
    @codex 请审查是否存在安全性回归、测试缺失和可能带来风险的行为变更。

    使用方法

    首先,将 Codex 代码审查添加到您的 GitHub 组织或代码仓库。 如需了解详情,请参阅 GitHub 中的 Codex 代码审查

    您可以设置 Codex 自动审查每个 Pull Request,也可以在 Pull Request 评论中使用 @codex review 请求审查。

    如果 Codex 标记出回归或潜在问题,您可以在 Pull Request 中发表评论,并使用后续提示让它修复问题,例如 @codex fix it

    这将启动一个新的云端聊天,用于修复该问题并更新 Pull Request。

    制定审查指南

    若要自定义 Codex 的审查内容,请将 ## Code Review Rules 部分添加到距离这些规则所适用的代码最近的 AGENTS.md 中。例如:

    ## Code Review Rules
    
    ### Experiment cohorts
    
    - Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
      Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

    将适用于整个代码仓库的规则放在根目录下的 AGENTS.md 中,并将针对特定服务的规则 放在子目录中的文件里。规则应保持简洁,说明要标记的行为以及任何 安全处理方式或例外情况,并将格式检查和 lint 检查交给 CI。请参阅 自定义 Codex 的审查内容 以了解设置方法和规则编写指南。

    相关使用场景