概要
Code Review は、pull request、コードの変更、レビューの指摘事項、コメント、チェックを 1 か所にまとめます。他の人の変更をレビューしたり、自分の pull request に寄せられたフィードバックを確認したり、返信する前に Codex に変更内容の説明を求めたりできます。
Code Review プラグインは、デスクトップとウェブでのレビューに対応しています。GitLab のマージリクエストのレビューは、プレビュー版として利用できます。GitLab のクラウドコードレビューは利用できません。
利用前の準備
レビュー対象の pull request にアクセスできるリポジトリアカウントを使用してください。閲覧や変更ができる範囲は、リポジトリの権限によって決まります。
管理対象のワークスペースでは、Code Review プラグインと必要なアプリ接続を利用できる状態にしておく必要があります。プラグインをインストールしても、リポジトリへのアクセス権は付与されません。
プラグインの設定とワークスペースの管理機能については、ChatGPT と Codex のプラグインをご覧ください。
pull request の検索
Code Review を開き、自分が作成した pull request やレビューを依頼された pull request を探します。検索とフィルターで一覧を絞り込み、pull request を選択します。
リポジトリ、タイトル、作成者、ブランチを確認し、意図した変更がレビュー対象になっていることを確かめます。説明には作成者の目的が記載され、差分には変更されたコードが表示されます。
変更内容のレビュー
pull request の説明と要約を読みます。
差分で、変更されたファイルと関連する行を確認します。
指摘事項と既存のコメントを確認します。
テスト結果、チェック、未解決のマージ競合を確認します。
さらに調査が必要な点は Codex に質問します。
生成された指摘事項を判断の根拠にする前に、関連するコードと照らし合わせて確認してください。
pull request に関する Codex への質問
pull request の会話で、変更内容について質問したり、指摘事項を調べたりできます。確認したい動作や重視するレビュー基準を含めてください。質問例:
「この変更がサインインにどう影響するか説明してください。」
「新しいエラー処理の経路で、データベース接続が解放されるか確認してください。」
「この指摘の根拠となるコードを示してください。」
「この修正をレビューのフィードバックと照らし合わせ、未解決の点を洗い出してください。」
Codex に修正案の作成を依頼することもできます。希望する変更と変更範囲の制約を伝え、生成された差分とテスト結果を確認してください。
依頼例:「エラー処理に関する指摘に対応してください。変更はこの関数に限定し、失敗するケースのテストを追加してください。」
コメントの送信、変更のコミット、マージを行う前に、結果を確認してください。
GitLab のマージリクエストのレビュー
GitLab 向けプレビュー版では、Code Review でマージリクエストを扱えます。変更内容を確認し、Codex の支援を受けながらレビューのフィードバックを理解して対応できます。
レビュー対象のアカウントとプロジェクトに対応する GitLab 接続を使用してください。接続方法とリポジトリの権限については、GitLab と ChatGPT・Codex の接続をご覧ください。
アプリ内のプレビュー版には、GitLab のクラウドコードレビューは含まれません。GitLab を接続したり、Code Review でマージリクエストを表示したりしても、そのリポジトリの自動クラウドレビューは有効になりません。
よくある質問
pull request を作成する前に、ローカルの変更をレビューできますか?
はい。Codex にローカルの変更のレビューを依頼できます。ローカルレビューの方法については、コードレビューガイドをご覧ください。
これにより、既存のクラウドレビューは新しいクラウド環境に移行されますか?
いいえ。今回のアップデートでは、既存のクラウドコードレビューは新しいクラウド環境に移行されません。
