Codex で GitHub pull request をレビューする

Codex のコードレビューを使用して、GitHub pull request をシグナルの高い別の観点からレビューできます。Codex は pull request の差分をレビューし、リポジトリのガイダンスに従って、 重大な問題に焦点を当てた標準の GitHub コードレビューを投稿します。リサーチプレビューとして 提供されている Security Review では、pull request に含まれる潜在的な セキュリティ問題をより詳細にレビューできます。

動画を見る: Codex コードレビューのウォークスルー

始める前に

次の準備が必要です。

• レビュー対象のリポジトリで Codex クラウドを設定していること。
• Codex コードレビュー設定にアクセスできること。
• Codex にリポジトリ固有のレビューガイダンスに従わせる場合は、AGENTS.md ファイルがあること。

Codex コードレビューを設定する

自動レビューを設定するには、接続済みの GitHub リポジトリと、 その設定に対する GitHub の push 権限または admin 権限が必要です。

1. Codex cloud をセットアップします。
2. Codex の設定に移動します。
3. リポジトリの Code review をオンにします。

Codex レビューをリクエストする

1. プルリクエストのコメントで @codex review とメンションします。
2. Codex がリアクション（👀）してレビューを投稿するまで待ちます。

Codex はチームメイトと同じように、プルリクエストへレビューを投稿します。 GitHub では、レビューコメントが優先度の高いリスクに集中するよう、Codex は P0 と P1 の問題のみを指摘します。

自動レビューを有効にする

Codex ですべての pull request を自動的にレビューするには、Codex の設定で Automatic reviews をオンにします。新しい PR がレビュー対象として作成されるたびに、@codex review コメントがなくても Codex がレビューを投稿します。

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 for issues in the database migration

Security Review

Security Review は、pull request のセキュリティ問題に 特に注意を払いたいお客様向けの追加レビューです。pull request の差分、 関連するリポジトリコンテキスト、設定済みの脅威モデルまたはセキュリティ ガイダンスを分析し、セキュリティ固有のリスクを Code Review より詳しく調査します。

Code Review でも一般的なレビューの一環としてセキュリティ関連の問題を 特定できるため、Code Review と Security Review の検出結果が一部重複する場合があります。

Security Review をセットアップする

より詳しいセットアップ手順と設定オプションについては、Security Reviewを参照してください。

1. Codex クラウドをセットアップします。
2. Codex settingsに移動します。
3. Repository preferences で、Security Review を実行する pull request と 実行タイミングを選択します。Code Review と一緒に実行するには、 Whenever code review runs を選択します。

Security Review をリクエストする

Security Review を手動でリクエストするには、pull request に次のコメントを追加します。

@codex security review

レビューの実行中は Codex がリアクションし、その後、セキュリティ上の検出結果を pull request に直接投稿します。関連付けられた Codex タスクを開き、Security Report タブを選択すると、レポート全体を確認できます。

レビューの指摘に対応する

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

@codex fix the P1 issue

Codex は pull request をコンテキストにしたクラウドチャットを開始し、権限があれば修正をブランチへ push できます。

Codex にその他のタスクを依頼する

コメントで review 以外の内容とともに @codex をメンションすると、Codex は pull request をコンテキストとしてクラウドチャットを開始します。

@codex fix the CI failures

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

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

• Codex の設定で、リポジトリの Code review をオンにしていることを確認します。
• pull request が、Codex cloud を設定済みのリポジトリに属していることを確認します。
• pull request のコメントで正確なトリガー @codex review を使用します。
• 自動レビューの場合は、Automatic reviews をオンにしていること、および pull request のイベントがレビューのトリガー設定と一致していることを確認します。