GitHub での Codex コードレビュー¶
Codex コードレビューを使用すると、GitHub のプルリクエストに対して、もう一度高品質なレビューを実施できます。Codex はプルリクエストの差分をレビューし、リポジトリのガイダンスに従って、重大な問題に焦点を当てた標準的な GitHub コードレビューを投稿します。
始める前に¶
以下を確認してください。
- レビュー対象のリポジトリで Codex cloud をセットアップしていること。
- Codex コードレビューの設定 にアクセスできること。
- Codex にリポジトリ固有のレビューガイダンスに従わせる場合は、
AGENTS.mdファイルがあること。
Codex コードレビューをセットアップする¶
- Codex cloud をセットアップします。
- Codex の設定 に移動します。
- リポジトリの コードレビュー をオンにします。
Codex にレビューを依頼する¶
- プルリクエストのコメントで
@codex reviewにメンションします。 - Codex が反応(👀)してレビューを投稿するまで待ちます。
Codex は、チームメイトが行う場合と同じように、プルリクエストにレビューを投稿します。GitHub では、レビューコメントを高優先度のリスクに集中させるため、Codex は P0 と P1 の問題のみを指摘します。
自動レビューを有効にする¶
Codex ですべてのプルリクエストを自動的にレビューする場合は、Codex の設定 で 自動レビュー をオンにします。@codex review コメントは必要なく、誰かが新しい PR をレビュー用に開くたびに、Codex がレビューを投稿します。
Codex がレビューする内容をカスタマイズする¶
Codex はリポジトリ内で AGENTS.md ファイルを検索し、そこに含まれる レビューガイドライン に従います。
リポジトリのガイドラインを設定するには、トップレベルにある AGENTS.md に次のようなセクションを追加または更新します。
Codex は、変更された各ファイルに対して最も近い AGENTS.md からガイダンスを適用します。特定のパッケージをより厳密に確認する必要がある場合は、ツリー内のより深い場所に、より具体的な指示を配置できます。
一時的に特定の点に焦点を当てる場合は、プルリクエストのコメントに追加します。
@codex review for security regressions
Codex にドキュメントの誤字を指摘させる場合は、AGENTS.md にガイダンスを追加します(たとえば、「ドキュメントの誤字を P1 として扱う」と指定します)。
レビュー結果に対応する¶
Codex がレビューを投稿した後、別のコメントを残して、同じプルリクエスト内の問題を修正するよう依頼できます。
Codex は、プルリクエストをコンテキストとしてクラウドチャットを開始し、権限がある場合はブランチに修正をプッシュできます。
Codex に他のタスクを依頼する¶
review 以外の内容とともにコメントで @codex にメンションすると、Codex はプルリクエストをコンテキストとして クラウドチャット を開始します。
コードレビューのトラブルシューティング¶
Codex が反応しない、またはレビューを投稿しない場合は、以下を確認してください。
- Codex の設定 で、リポジトリの コードレビュー をオンにしたことを確認します。
- プルリクエストが、Codex cloud をセットアップ済みのリポジトリに属していることを確認します。
- プルリクエストのコメントで、正確なトリガー
@codex reviewを使用します。 - 自動レビューの場合は、自動レビュー をオンにしたこと、およびプルリクエストのイベントがレビューのトリガー設定と一致していることを確認します。