Skip to main content

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

pull request では、コミット、変更されたファイル、ベース ブランチと比較ブランチでのファイル間の違い (つまり "diff") をレビューしたり話し合ったりできます。

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

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

ヒント: 検索修飾子 review-requested:[USERNAME] または team-review-requested:[TEAMNAME] が使用された、自分または自分がメンバーであるチームが確認を求められているプルリクエストを探すことができます。 詳細については、「Searching issues and pull requests」 (問題とプルリクエストの検索) を参照してください。

レビューを開始する

  1. リポジトリ名の下にある [pull request] をクリックします。 [Issues and pull requests](issue と pull request) タブの選択 1. プルリクエストのリストで、レビューしたいプルリクエストをクリックします。 1. pull request で、 [変更されたファイル] をクリックします。 Pull Request の [Files changed](変更されたファイル) タブ

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

    差分ビューの設定

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

  2. 必要に応じて、ファイルをフィルター処理して、レビューするファイルのみを表示するか、ファイル ツリーを使って特定のファイルに移動します。 詳しくは、「pull request 内のファイルをフィルタリングする」を参照してください。

  3. コメントを追加するコード行にカーソルを合わせ、青いコメント アイコンをクリックします。 複数行にコメントを追加するには、クリックしてドラッグして行の範囲を選択し、青いコメント アイコンをクリックします。 青いコメント アイコン 1. コメントフィールドにコメントを入力してください。 コメント フィールド 1. 必要に応じて、1 つまたは複数の行に固有の変更を提案するには、 をクリックした後、提案ブロック内のテキストを編集します。 提案ブロック

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

    [Start a review] ボタン

レビューを提出する前は、行のコメントは 保留中 であり、ご自分にしか見えません。 レビューを提出する前ならばいつでも、保留中のコメントを編集できます。 その保留中のコメントのすべてを含めて、保留中のレビューをキャンセルするには、[会話] タブでタイムラインの最後まで下にスクロールし、 [レビューをキャンセルする] をクリックします。

[レビューのキャンセル] ボタン

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

  1. pull request を開く」の説明に従って、codespace で pull request を開きます。

  2. アクティビティ バーで [GitHub の pull request] ビューをクリックします。 このビューは、codespace で pull request を開く場合にのみ表示されます。

    codespace で PR を開くオプション

  3. 特定のファイルを確認するには、サイド バーの [ファイルを開く] アイコンをクリックします。

    codespace で PR を開くオプション

  4. レビュー コメントを追加するには、行番号の横にある + アイコンをクリックします。 レビュー コメントを入力し、 [レビューの開始] をクリックします。

    codespace で PR を開くオプション

  5. レビュー コメントの追加が完了したら、サイド バーからコメントの送信、変更の承認、または変更の要求のいずれかを選択できます。

    codespace で PR を開くオプション

GitHub Codespaces で pull request をレビューする方法について詳しくは、「pull request で GitHub Codespaces を使用する」をご覧ください。

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

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

  1. pull request で、 [変更されたファイル] をクリックします。 Pull Request の [Files changed](変更されたファイル) タブ

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

    リッチ diff ボタン

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

    ソース diff のビューに戻るには、 ボタンをクリックしてください。

    ソース diff ボタン

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

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

  1. pull request で、 [変更されたファイル] をクリックします。 Pull Request の [Files changed](変更されたファイル) タブ

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

    [Viewed] チェックボックス

レビューを提出する

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

  1. pull request で、 [変更されたファイル] をクリックします。 Pull Request の [Files changed](変更されたファイル) タブ 1. 変更されたコードの上にある [変更の確認] をクリックします。 [変更の確認] ボタン 1. 提案された変更についてのフィードバックをまとめたコメントを入力してください。 レビューのまとめコメント ウィンドウ

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

    レビュー オプションを選択するラジオ ボタン

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

ヒント:

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

参考資料