GitHub での Codex コードレビュー

Codex コードレビューを使用すると、GitHub pull request に対して、重要な指摘に絞ったもう一段階のレビューを行えます。Codex は pull request の差分をレビューし、リポジトリのガイダンスに従い、重大な問題に重点を置いた標準の GitHub コードレビューを投稿します。

始める前に

次の準備が必要です。

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

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

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

Codex にレビューを依頼する

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

Codex は、チームメンバーと同じように pull request へレビューを投稿します。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 security regressions

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

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 のイベントがレビューのトリガー設定と一致していることを確認します。