プルリクエストでの「Start a review」と「Add single comment」の使い分けがよくわかってなかったのでまとめてみた
普段プルリクエスト上でコードレビューする時に，全て「Add single comment」でコメントを入れていました．
この方法でもコードレビューは普通にできますが，先日 GitHub 社の方と話す機会があり，その時に「Start a review」と「Add single comment」をどのように使い分けるかをアドバイス頂いたのでまとめておきます．
チームや人によって使い方は様々なのであくまで参考程度に見て頂ければと思います．
「Reviewers」でレビュアーを指定する
まずはレビューイ（レビューしてもらう人）が「Reviewers」の項目でレビュアー（レビューする人）を指定します．
今までの私はプルリクエストの画面でレビュアーになって欲しいメンバーにメンション付きでコメントしたり，Slack上で依頼をしていたのでまぁ指定しなくて良いかなぁと思っていました😅．
「Reviewers」でレビュアーを指定するのが毎回面倒，「Reviewers」にしたメンバーにSlackなどのツールで改めてお願いするのが面倒な人は「Pull Panda」というサービスがオススメです．
「Start a review」の使い方
この機能の使い方が今まで謎だったのですが，「Start a review」は「Reviewers」にしたメンバー，つまりレビュアーが使う機能のようです． 例えば私がレビュアーの場合は以下のようにコメントを入れて「Start a review」を押します．
コメントした箇所に「Pending」と表示されます．この時点では該当箇所にコメントしたことはレビューイの画面に表示されません．コメントしたレビュアーにのみ表示されます．
2回目以降のコメントは「Add review comment」でコメントを入れていきます．
レビューが終わったら，画面右上にある「Finish your review」または「Review changes」を押します．そうすると入力欄が表示されるので，ここにレビュー内容についての総評などを入れて「Submit review」を押します．
これでレビューイの画面にレビュアーのコメントが表示され，内容を確認できます．
「Add single comment」の使い方
特に決まった使い方はありませんが，以下のような使い方があるのかなぁと考えてます．
- レビューイが実装したコードの補足のコメントを入れたい
- レビューイ，レビュアー以外のメンバーがコメントしたい
レビューイ，レビュアー以外のメンバーがふとコメントした内容が実は大事であった場面がよくありました😅．
使い方を知ってみての所感
「Start a review」と「Add single comment」の使い方は冒頭にもある通り色々な使い方があるので明確な正解はそこまで無いのかなぁと思いました．
例えば
- ウチではチーム全員がレビュアーになってコードレビューするので「Reviewers」は特に指定しない
- 「Add single comment」を使った方が Slack に通知されるのでレビューイが「お！今レビューしてもらってる！」とわかるようにしている
など聞いたことがあることを思い出しました．
私の場合，今までよくわからないまま使っていたので今回をきっかけに使い分けについて自分なりに整理できて良かったです．
「Start a review」を使った方法でしばらくはコードレビューしていこうと思います．
