日本語

コードレビュー

ChatGPT および Codex クライアントでコードの変更をレビューします

コミットまたはプッシュする前に、ChatGPT または Codex を使用してコードの変更を確認します。

レビューを開始する

アプリでレビューする

レビューペインを開くと、変更内容を把握し、行ごとのフィードバックを提供して、 ステージ、元に戻す、コミット、プッシュの対象を決められます。

Codex に変更のレビューを依頼するには、コンポーザーに /review と入力します。 ベースブランチとの差分をレビューまたは未コミットの変更をレビューを選択します。Codex は 作業ツリーを変更せず、優先順位を付けた指摘事項を報告します。

レビューペインを使用するには、プロジェクトが Git リポジトリ内にある必要があります。プロジェクトが まだ Git リポジトリでない場合、アプリに作成を促すメッセージが表示されます。

レビュー範囲を選択する

表示される変更

レビューペインには、Codex が編集した内容だけでなく、Git リポジトリの状態が 反映されます。Codex による変更、自分で加えた変更、リポジトリ内の その他すべての未コミットの変更が含まれます。

デフォルトでは、レビューペインにステージされていない変更が表示されます。Git インデックスには ステージ済み、選択したコミットにはコミット、ベースブランチとの差分には ブランチ、直近のアシスタントターンには前回のターンを使用します。

複数のリポジトリをレビューする

ローカルプロジェクトに複数のフォルダーが含まれ、 それぞれが異なる Git リポジトリに対応している場合、レビューペインには各 リポジトリの変更を表示できます。レビューのヘッダーにあるリポジトリセレクターを開くと、 現在のレビューペインを離れずに別のリポジトリを確認し、追加または削除された行を 表示できます。

接続されている複数のリポジトリにわたるアシスタントの最新の変更を表示するには、前回のターンを選択します。 このビューでは、リポジトリセレクターにすべてのリポジトリと表示されます。ステージされていないステージ済みブランチなど、その他のレビュー範囲は、選択した リポジトリに適用されます。

レビュー結果を活用する

コードレビューの結果

レビューの指摘事項は、レビューペインにインラインコメントとして表示されます。

デフォルトでは、レビューは現在のチャットで実行されます。設定 > 一般 > コードレビュー分離を選択すると、別のレビューチャットが開始されます。 開発者設定を参照してください。

レビューペインに表示されたインラインのコードレビューコメント

Codex に検出した問題の修正を依頼する場合は、通常のサンドボックスと承認の 設定が適用されます。

レビューペイン内を移動する

  • 通常、ファイル名をクリックすると、選択したエディターでそのファイルが開きます。 デフォルトのエディターは開発者設定で選択できます。
  • ファイル名の背景をクリックすると、差分が展開または折りたたまれます。
  • Cmd を押しながら1行をクリックすると、選択したエディターでその行が開きます。
  • 変更に問題がなければ、ステージするか、不要な変更を元に戻すことができます。

フィードバック用のインラインコメント

インラインコメントを使用すると、差分内の特定の行にフィードバックを直接添付できます。 多くの場合、Codex を適切な修正へ導く最も速い方法です。

インラインコメントを残すには、次の手順に従います。

  1. レビューペインを開きます。
  2. コメントしたい行にカーソルを合わせます。
  3. 表示される + ボタンを選択します。
  4. フィードバックを入力して送信します。
  5. フィードバックをすべて残したら、チャットにメッセージを送信します。

コメントは行に紐づいているため、Codex は一般的な指示よりも 正確に対応できます。

Codex はインラインコメントをレビューのガイダンスとして扱います。コメントを残した後、 たとえば「インラインコメントに対応し、変更範囲は最小限にしてください」のように、意図を明確にする フォローアップメッセージを送信してください。

プルリクエストのレビュー

Codex がリポジトリの GitHub にアクセスでき、現在のプロジェクトが プルリクエストのブランチにある場合、ChatGPT デスクトップアプリを使用すると、アプリを離れずに プルリクエストのフィードバックへ対応できます。サイドバーにはプルリクエストの コンテキストとレビュアーからのフィードバックが表示され、レビューペインにはコメントが 差分と並んで表示されるため、同じチャットで問題への対応を Codex に依頼できます。

GitHub CLI(gh)をインストールし、gh auth login で認証すると、Codex が プルリクエストのコンテキスト、レビューコメント、変更されたファイルを読み込めるようになります。gh が 存在しないか認証されていない場合、プルリクエストの詳細がサイドバーや レビューペインに表示されないことがあります。

修正の一連の流れを1か所で完結させたい場合は、次の手順を使用します。

  1. プルリクエストのブランチでレビューペインを開きます。
  2. プルリクエストのコンテキスト、コメント、変更されたファイルを確認します。
  3. 対応したい特定のコメントを修正するよう Codex に依頼します。
  4. レビューペインで生成された差分を確認します。
  5. 準備ができたら、変更をステージ、コミットし、プルリクエストのブランチへプッシュします。

GitHub を起点とするレビューについては、GitHub で Codex を使用するを参照してください。

ファイルをステージする、または元に戻す

レビューペインには Git の操作が用意されており、コミットする前に 差分を整えられます。

次の単位で、変更をステージ、ステージ解除、または元に戻すことができます。

  • 差分全体: すべてステージすべて元に戻すなど、レビューのヘッダーにある操作ボタンを使用します。
  • ファイル単位: 個々のファイルをステージ、ステージ解除、または元に戻します。
  • ハンク単位: 1つのハンクをステージ、ステージ解除、または元に戻します。

作業の一部を採用する場合はステージを使用し、破棄する場合は 元に戻します。

ステージ済みとステージされていない状態

Git では、同じファイル内にステージ済みの変更とステージされていない変更の両方が存在することがあります。その 場合、両方のビューに同じファイルが表示されることがあります。これは Git の 通常の動作です。