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

プルリクエストのレビューについて

プルリクエストの変更は、1 ファイルごとにレビューできます。プルリクエストでファイルを確認しているときに、特定の変更について個別のコメントを残すことができます。各ファイルの確認が終了したら、ファイルを閲覧済みとしてマークできます。これによりファイルが折りたたまれるので、まだレビューを必要とするファイルを特定するのに役立ちます。プルリクエストヘッダのプログレスバーには、閲覧したファイル数が表示されます。必要な数のファイルを確認した後、要約コメントを付けて確認を送信することにより、プルリクエストを承認するか、追加の変更をリクエストできます。

Tip

検索修飾子 review-requested:[USERNAME] または team-review-requested:[TEAMNAME] が使用された、自分または自分がメンバーであるチームが確認を求められているプルリクエストを探すことができます。詳しくは、「Issue およびプルリクエストを検索する」を参照してください。

レビューを開始する

リポジトリ名の下にある [pull request] をクリックします。
プルリクエストのリストで、レビューしたいプルリクエストをクリックします。
pull request で、 [変更されたファイル] をクリックします。

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

空白の違いを非表示にすることもできます。この選択は、この pull request にのみ適用され、次回このページにアクセスするときに記録されます。
必要に応じて、ファイルをフィルター処理して、レビューするファイルのみを表示するか、ファイルツリーを使って特定のファイルに移動します。詳しくは、「プルリクエスト内のファイルをフィルタリングする」をご覧ください。
コメントを追加するコード行にカーソルを合わせ、青いコメントアイコンをクリックします。
必要に応じて、複数行にコメントを追加できます。コメントする最初の行の行番号をクリックし、下にドラッグして行の範囲を選択し、コメントする最後の行の青いコメントアイコンをクリックします。または、コメントする最初の行の横にある青いコメントアイコンをクリックし、コメントする最後の行まで下にドラッグします。
コメントフィールドにコメントを入力してください。
必要に応じて、1 つまたは複数の行に固有の変更を提案するには、をクリックした後、提案ブロック内のテキストを編集します。
ファイルに直接コメントするには、ファイルの右側にあるをクリックしてコメントを入力します。
終了したら [レビューの開始] をクリックします。レビューを既に開始していた場合は、 [レビューコメントを追加] をクリックします。

レビューを提出する前は、行のコメントは 保留中 であり、ご自分にしか見えません。レビューを提出する前ならばいつでも、保留中のコメントを編集できます。保留中のすべてのコメントを含め、保留中のレビューを取り消すには、変更されたコードの上にある [変更の確認] をクリックし、 [レビューの破棄] をクリックします。

GitHub Codespaces を使って、pull request をテスト、実行、レビューすることができます。

「pull request で GitHub Codespaces を使用する」の説明に従って、codespace で pull request を開きます。
[Activity Bar] の [GitHub Pull Request] ビューをクリックします。このビューは、codespace で pull request を開く場合にのみ表示されます。
特定のファイルを確認するには、サイドバーの [ファイルを開く] アイコンをクリックします。
レビューコメントを追加するには、行番号の横にある + アイコンをクリックします。レビューコメントを入力し、 [レビューの開始] をクリックします。
レビューコメントの追加が完了したら、サイドバーからコメントの送信、変更の承認、または変更の要求のいずれかを選択できます。

GitHub Codespaces での pull request の表示については、「pull request で GitHub Codespaces を使用する」を参照してください。

Pull request の変更の理解

Note

GitHub Copilot のサブスクリプションが必要です。詳しくは、「GitHub Copilot とは何ですか?」を参照してください。

GitHub Copilot を使うと、特定のコミットのコンテキストと説明が提供されるので、pull request の変更をすばやく理解することができます。特定の変更の目的がわからない場合、またはより広範なコードベースにどのように適合するかについてより詳細な情報が必要な場合は、個々のコミットについて Copilot に質問できます。

GitHub のコミットに移動します。
GitHub の任意のページの右上で、検索バーの横にある GitHub Copilot アイコンをクリックします。

GitHub Copilot Chat パネルが表示されます。パネルのサイズ変更を行うには、上端または左端をクリックしてドラッグします。
パネルに Copilot との以前の会話が含まれている場合、Copilot パネルの右上にあるプラス記号アイコンをクリックして、新しい会話を開始します。
data variables.product.prodname_copilot_short %}チャットパネルの下部にある「Ask Copilot」ボックスに質問を入力し、Enterキーを押します。たとえば、次のように入力できます。
- Summarize the changes in this commit
- Who committed these changes?
- When was this commit made?
Tip

コミットの SHA がわかっている場合は、コミットに移動する代わりにメッセージに SHA を含めることにより、Copilot に GitHub のリポジトリ内の任意のページからコミットについて問い合わせることができます。たとえば、What changed in commit a778e0eab? のように指定します。
必要に応じて、テキストボックスのをクリックして、Copilot が応答を続行しないようにします。

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

プルリクエストに依存関係への変更が含まれている場合は、マニフェストまたはロックファイルの依存関係のレビューを使用して、何が変更されたかを確認し、変更によるセキュリティの脆弱性の発生の有無を確認できます。詳しくは、「プルリクエスト内の依存関係の変更をレビューする」をご覧ください。

pull request で、 [変更されたファイル] をクリックします。
マニフェストまたはロックファイルのヘッダーの右側で、 [] リッチ diff ボタンをクリックして、依存関係レビューを表示します。
依存関係を変化させないような変更がマニフェストあるいはロックファイルに行われているかもしれず、あるいはGitHubがパースできず、その結果として依存関係レビューに現れてこない依存関係があるかもしれないので、ソースdiffをレビューしたいこともあるでしょう。

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

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

ファイルのレビュー後は、そのファイルをレビュー済みとしてマークできます。マークしたファイルは折りたたまれます。ファイルを表示後に変更すると、レビュー済みマークが解除されます。

pull request で、 [変更されたファイル] をクリックします。
レビューを完了したファイルの、ヘッダーの右側にある [表示済み] を選びます。

レビューを提出する

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

pull request で、 [変更されたファイル] をクリックします。
変更されたコードの上にある [変更の確認] をクリックします。
提案された変更についてのフィードバックをまとめたコメントを入力してください。
残しておくレビューの種類を選択します。
- 変更を明示的に承認したり、追加の変更を要求したりせずに、一般的なフィードバックを残すには、 [コメント] を選びます。
- フィードバックを提出して、pull request で提案された変更をマージすることを承認するには、 [承認] を選びます。
- pull request をマージする前に対処する必要があるフィードバックを送信するには、 [変更の要求] を選びます。
[レビューをサブミット] をクリックします。

Tip

リクエストの変更オプションは純粋に情報提供を目的としており、ルールセットまたはクラシックブランチ保護ルールが [pull request の要求] オプションで構成されていない限り、マージの防げにはなりません。ルールが構成されており、リポジトリへの admin、owner、または write アクセス権を持つコラボレーターが変更を要求するレビューを送信した場合、同じコラボレーターが pull request の変更を承認する別のレビューを送信するまで、pull request をマージすることはできません。
リポジトリのオーナーと管理者は、プルリクエストが承認レビューを受けていなかったり、あるいは変更をリクエストしたレビュー担当者がOrganizationを離れていたりアクセスできなくなっている場合でも、プルリクエストをマージできます。
必須レビューと古いレビューの棄却がどちらも有効化されており、承認済みのプルリクエストのブランチにコードを変更するコミットがプッシュされた場合、その承認は却下されます。そのプルリクエストは、再度レビューされ承認されるまではマージできません。
同じコミットを指す複数のオープンされたプルリクエストがあり、それぞれがheadブランチを持つ場合、いずれかがペンディングあるいは拒否されたレビューを持っているなら、それらはマージできません。
書き込みまたは管理者のアクセス許可を持つ個人からのレビューの承認を必須としているリポジトリの場合、これらのアクセス許可を持つ個人からの承認には緑色のチェックマークが表示され、これらのアクセス許可を持たない個人からの承認には灰色のチェックマークが表示されます。灰色のチェックマークが付いた承認は、pull request をマージできるかどうかに影響しません。
Pull Requestの作者は、自分自身のPull Requestを承認することはできません。