プルリクエストで提案された変更をレビューする
Pull Request では、コミット、変更されたファイル、ベース ブランチと比較ブランチでのファイル間の違い (つまり "diff") をレビューしたり議論したりできます。
本記事の内容:
プルリクエストのレビューについて
プルリクエストの変更は、1 ファイルごとにレビューできます。 プルリクエストのファイルをレビューしている際に、特定の変更についてコメントを残すことができます。任意の数のファイルをレビュー後、プルリクエストを承認するか、レビューに要約コメントを付けてサブミットし、さらなる変更をリクエストできます。
参考: あなた、もしくはあなたがメンバーになっている Team がレビューを求められているプルリクエストは、review-requested:[USERNAME]
あるいは team-review-requested:[TEAMNAME]
という検索条件で検索できます。詳細は「Issue およびプルリクエストを検索する」を参照してください。
レビューを開始する
-
リポジトリ名の下で [Pull requests] をクリックします。
-
プルリクエストのリストで、レビューしたいプルリクエストをクリックします。
-
プルリクエストで [Files changed] をクリックします。
-
コメントを追加したいコードの行の上にカーソルを移動させ、青いコメントアイコンをクリックします。
-
コメントフィールドにコメントを入力します。
- 完了したら、[Start a review] をクリックします。 レビューがすでに開始していた場合は、[Add review comment] (レビューコメントを追加) をクリックします。
レビューを提出する前は、行のコメントは保留中であり、自分にしか見えません。 レビューを提出する前ならばいつでも、保留中のコメントを編集できます。 その保留中のコメントのすべてを含めて、保留中のレビューをキャンセルするには、[Conversation] タブでタイムラインの最後まで下にスクロールし、[Cancel review] をクリックします。
レビューを提出する
プルリクエスト内でレビューしたいファイルをすべてレビューし終えたら、レビューをサブミットします。
-
プルリクエストで [Files changed] をクリックします。
-
変更されたコードの上で [Review changes(変更のレビュー)] をクリックします。
-
提案された変更に対するフィードバックをまとめたコメントを入力します。
-
残しておくレビューの種類を選択します:
- 変更を明確には承認せず、さらなる変更をリクエストすることもなく、おおまかなフィードバックだけを残したい場合は、[Comment] を選択します。
- フィードバックを提出して、Pull Request で提案された変更をマージすることを承認するには、[Approve] を選択します。
- Pull Request をマージする前に対処すべき問題をフィードバックするには、[Request changes] を選択します。
-
[Submit review] をクリックします。
ヒント:
- 必須レビューが有効化されており、リポジトリへの書き込み、管理、オーナーのいずれかの権限を持つコラボレータがレビューを要求する変更をサブミットすると、そのプルリクエストは同じコラボレータがプルリクエスト中の変更を承認する他のレビューをサブミットするまではマージできません。
- リポジトリのオーナーと管理者は、プルリクエストが承認レビューを受けていなかったり、あるいは変更をリクエストしたレビュー担当者がOrganizationを離れていたりアクセスできなくなっている場合でも、プルリクエストをマージできます。
- 必須レビューと古いレビューの棄却がどちらも有効化されており、承認済みのプルリクエストのブランチにコードを変更するコミットがプッシュされた場合、その承認は却下されます。 そのプルリクエストは、再度レビューされ承認されるまではマージできません。
- 同じコミットを指す複数のオープンされたプルリクエストがあり、それぞれがheadブランチを持つ場合、いずれかがペンディングあるいは拒否されたレビューを持っているなら、それらはマージできません。