For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
メインナビゲーション
Theme

GitHub の pull requests を Codex でレビュー

GitHub の pull requests 向けにコードレビューとセキュリティレビューを設定し、@codex review と @codex security review でレビューを依頼する方法を説明します。自動レビューの有効化や、AGENTS.md に独自のレビュールールを記述する方法も紹介します。

GitHub の pull requests に Codex のコードレビューを追加すると、重大な問題に絞った指摘を受けられます。Codex はリポジトリの指針に従って pull request の差分を確認し、GitHub の標準のコードレビューとして結果を投稿します。リサーチプレビューで利用できるセキュリティレビューでは、pull request に潜むセキュリティ上の問題をより詳しく調べます。


事前準備

次のものを用意してください。

Codex のコードレビューの設定

自動レビューを設定するには、Codex に接続した GitHub リポジトリと、そのリポジトリの設定に対する GitHub のプッシュ権限または管理者権限が必要です。

  1. GitHub リポジトリを Codex に接続します。
  2. Codex の設定を開きます。
  3. リポジトリを選択し、自動レビューをオンにします。この項目はコードをレビューにあります。

Codex へのレビュー依頼

  1. pull request のコメントに @codex review と入力します。
  2. Codex がリアクション(👀)を付け、レビューを投稿するまで待ちます。

Codex はチームメンバーと同じように、pull request にレビューを投稿します。GitHub では、優先度の高いリスクにレビューコメントを絞るため、Codex が指摘するのは P0 と P1 の問題だけです。


自動レビューの有効化

自分の pull requests を自動レビューの対象にするには、自動レビューをオンにします。この項目は、個人設定(Codex の設定内)にあります。レビューを実行するタイミングはレビュートリガーで選択します。この設定はコードレビューが有効なリポジトリに適用され、@codex review のコメントは不要です。

Codex のレビュー内容のカスタマイズ

Codex はリポジトリ内の AGENTS.md ファイルを探し、該当するコードレビューのルールに従います。## Code Review Rules セクションは、ルールの対象となるコードに最も近いファイルに追加します。必要に応じて、### 見出しで関連するチェック項目をまとめます。

たとえば、実験結果を集計するサービスでは、施策への接触後の行動によって比較対象のコホートが変わるのを防ぐために、次のルールを設けられます。

## 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 に、サービス固有のルールは services/experiment_reporting/AGENTS.md などのサブディレクトリ内のファイルに記載します。Codex は変更されたファイルごとに、ルートの指針と、そのファイルに適用されるより具体的な指針を使います。そのため、無関係な変更にサービス固有の事情を持ち込まずに済みます。

まずは、レビュー担当者が繰り返し説明している確認事項を、2~3 個の簡潔なルールにまとめます。ルールを書く際は、次の点を意識してください。

  • 影響が大きく、リポジトリに固有の挙動に焦点を当てます。 指摘すべき互換性の制約、データの境界、危険な副作用を具体的に挙げ、なぜ重要なのかを説明します。
  • 安全な対処方法や例外を明記します。 Codex が実際の問題と想定どおりの挙動を区別できるように、必要な背景を示します。
  • 適用範囲を絞り、長く使えるルールにします。 変更される可能性がある関数名よりも期待する結果を重視し、指針は対象のコードの近くに置きます。
  • 機械的なチェックは CI に任せます。 フォーマットや lint など、結果が一意に決まるチェックはレビュールールから除きます。

典型的な変更を含む pull request を開き、@codex review でレビューを依頼します。指摘やフィードバックをもとにルールを改善し、不要な指摘につながる指針は適用範囲を狭めるか削除します。

コードレビューのルールは Codex の判断を導くものです。テスト、ブランチ保護、必須の承認に代わるものではありません。

今回のレビューで特に確認してほしい点があれば、pull request のコメントに追記します。

@codex review データベースのマイグレーションに問題がないか確認してください

セキュリティレビュー

セキュリティレビューは、pull requests のセキュリティ上の問題を重点的に確認したい場合に利用できる追加のレビューです。pull request の差分、関連するリポジトリ内の情報、設定済みの脅威モデルやセキュリティ指針を分析し、セキュリティ固有のリスクをコードレビューよりも詳しく調べます。

通常のコードレビューでもセキュリティに関する問題が見つかることがあるため、両方のレビューで同じ問題が指摘される場合があります。

セキュリティレビューの設定

詳しい設定手順や設定項目については、セキュリティレビューを参照してください。

  1. GitHub リポジトリを Codex に接続します。
  2. Codex の設定を開きます。
  3. リポジトリを選択します。セキュリティ脆弱性をレビューで自動セキュリティレビューをオンにし、レビューで誰の pull requests を対象にするかを選びます。トリガーをコードレビューの実行時に設定すると、コードレビューのたびにセキュリティレビューも実行されます。

セキュリティレビューの依頼

セキュリティレビューを手動で依頼するには、pull request に次のコメントを追加します。

@codex security review

Codex はレビュー中にリアクションを付け、完了するとセキュリティ上の指摘を pull request に直接投稿します。レポート全体を確認するには、対応する Codex タスクを開き、セキュリティレポートタブを選択します。

レビューの指摘への対応

Codex がレビューを投稿した後、同じ pull request に追加のコメントを投稿して、問題の修正を依頼できます。

@codex fix the P1 issue

Codex は pull request をコンテキストとして従来版のクラウドチャットを開始します。プッシュ権限があれば、修正を元のブランチにプッシュできます。

Codex へのその他のタスクの依頼

コメントで @codex に続けて review 以外の内容を指定すると、Codex は pull request をコンテキストとして従来版のクラウドチャットを開始します。

@codex fix the CI failures

コードレビューのトラブルシューティング

Codex がリアクションを付けない場合や、レビューを投稿しない場合は、次の点を確認してください。

  • Codex の設定で、対象のリポジトリのコードレビューが有効になっていることを確認します。
  • pull request が、Codex に接続した GitHub リポジトリのものであることを確認します。
  • pull request のコメントには、トリガーを @codex review と正確に入力します。
  • 自動レビューの場合は、自動レビューの設定を、対象リポジトリの設定と個人設定の両方で確認します。どちらもCodex の設定から開けます。pull request のイベントが、設定したレビュートリガーに一致することも確認します。