プルリクエストで提案された変更をレビューする

pull request の目的を理解する

pull request の背後にある動機を理解することは、レビューを対象とし、意味のあるものに保つのに役立ちます。 また、pull request 作成者の意図とプロジェクトの目標に合ったフィードバックを提供するのにも役立ちます。

提案された変更のコンテキストと根拠をより深く理解するためのオプションがいくつかあります。

コンテキストに対する pull request サイドバーの使用

pull request サイドバーには、次のような重要なコンテキストがあります。

• リンクされた 問題 または ディスカッション: プル要求が対処することを目的とする問題または目標を理解するために、これらを確認します。 また、背景、設計上の決定、または現在の議論に関する情報を収集することもできます。
• リンクされた プロジェクト または マイルストーン: この pull request が大規模なプロジェクトまたは今後のリリースにどのように適合するかを確認します。

この情報を使用して、レビューのフレームを作成し、pull request の目標が元の意図と一致しているかどうかを確認します。

コパイロットチャットを使用して根拠を理解する

pull request の意図を理解したり、変更の一部を明確にしたりするために、 コパイロットチャット に問い合わせることができます。

1. pull request ページの右上にある検索バーの横にある ボタンをクリックします。

コパイロットチャット が表示され、プロンプト ウィンドウにコンテキストとしてプル要求がアタッチされます。

1. プロンプト ボックスに質問を入力して Enter キーを押します。 たとえば、次のように入力できます。

   • What problem does this pull request solve?
   • Why were these changes needed?
   • Summarize the goals of this PR based on the linked issue.
   • How does this PR relate to issue ISSUE-URL?

コパイロットチャット は、行レベルのレビューを開始する前に、全体像を明確にするのに役立ちます。

レビューを開始する

1. リポジトリ名の下にある [Pull requests] をクリックします。

   

2. プルリクエストのリストで、レビューしたいプルリクエストをクリックします。

3. Pull request で、[ Files changed] をクリックします。

   このタブで差分ビューの形式を変更するには、[ ] をクリックし、統合ビューまたは分割ビューを選択します。 他の pull request の差分を表示する場合も、この選択が適用されます。

   

   空白の違いを非表示にすることもできます。 この選択は、この pull request にのみ適用され、次回このページにアクセスするときに記録されます。

4. 必要に応じて、ファイルをフィルター処理して、確認するファイルのみを表示します。または、ファイル ツリーを使って特定のファイルに移動します。

5. コメントを追加するコード行にカーソルを合わせ、青いコメント アイコンをクリックします。

   

6. 必要に応じて、複数行にコメントを追加できます。 行の範囲を選択するには、コメントする最初の行の行番号をクリックし、最後の行までドラッグするか、 Shift キー を押しながら最後の行番号をクリックします。 その後、コメントする最後の行の青いコメント アイコンをクリックできます。 または、コメントする最初の行の横にある青いコメント アイコンをクリックし、コメントする最後の行まで下にドラッグします。

7. コメントフィールドにコメントを入力してください。

8. 必要に応じて、1 つまたは複数の行に固有の変更を提案するには、 をクリックした後、提案ブロック内のテキストを編集します。

   

9. ファイルに直接コメントするには、ファイルの右側にある をクリックしてコメントを入力します。

   

10. 終了したら [レビューの開始] をクリックします。 レビューを既に開始していた場合は、 [レビューコメントを追加] をクリックします。

レビューを提出する前は、行のコメントは 保留中 になっており、ご自分にしか見えません。 レビューを提出する前ならばいつでも、保留中のコメントを編集できます。 保留中のレビュー (保留中のすべてのコメントを含む) を取り消すには、[ 変更の確認] をクリックし、[ レビューの中止] をクリックします。

依存関係の変更をレビューする

プル要求に依存関係への変更が含まれている場合は、マニフェストまたはロック ファイルの依存関係レビューを使用して、変更された内容を確認できます。 また、変更によってセキュリティの脆弱性が発生するかどうかを確認することもできます。 「プルリクエスト内の依存関係の変更をレビューする」を参照してください。

1. Pull request で、[ Files changed] をクリックします。

   

2. マニフェストまたはロック ファイルのヘッダーの右側で、 リッチ差分ボタンをクリックして依存関係の確認を表示します。

   

3. 依存関係を変化させないような変更がマニフェストあるいはロックファイルに行われているかもしれず、あるいはGitHubがパースできず、その結果として依存関係レビューに現れてこない依存関係があるかもしれないので、ソースdiffをレビューしたいこともあるでしょう。

   ソース差分ビューに戻るには、 ボタンをクリックします。

   

ファイルをレビュー済みとしてマークする

ファイルの確認が完了したら、ファイルを表示済みとしてマークできます。 ファイルは折りたたまれます。 ファイルを表示した後にファイルが変更された場合、「閲覧済み」マークが解除されます。

1. Pull request で、[ Files changed] をクリックします。

   

2. レビューを完了したファイルの、ヘッダーの右側にある [表示済み] を選びます。

   

レビューを提出する

プルリクエスト内でレビューしたいファイルをすべてレビューし終えたら、レビューをサブミットします。

1. Pull request で、[ Files changed] をクリックします。

   

2. 変更されたコードの上にある [変更の確認] をクリックします。

   

3. 提案された変更についてのフィードバックをまとめたコメントを入力してください。

4. 残しておくレビューの種類を選択します。

   • 変更を明示的に承認したり、追加の変更を要求したりせずに、一般的なフィードバックを残すには、 [コメント] を選びます。
   • フィードバックを提出して、pull request で提案された変更をマージすることを承認するには、 [承認] を選びます。
   • pull request をマージする前に対処する必要があるフィードバックを送信するには、 [変更の要求] を選びます。

5. [レビューをサブミット] をクリックします。