明るくない分野やプロジェクト入りして日が浅い時などなど、レビューで指摘を多くいただくケースがあると思います。
そういった時って、対応漏れをしてしまったり、どこから手をつけたら良いのかわからなくなったりして、負のスパイラルに陥りがち、、
今回、GitHubを用いた場合に、プルリクでレビューコメント多く受けた時の対応手順をまとめました。
要点
まず、本記事の要点です。
- 全コメントをザッと眺める
- 軽微な内容に対応
- 中程度の内容に対応
- 高難度の内容に対応
- 対応コメントの見直し
- Submit a review（完了報告）
のように進めると、無理なく抜け漏れなく対応できます。
手順
具体的な手順をご紹介します。
1. 全コメントをザッと眺める
まずは、レビューコメント全体をザックリ眺めます。
どのような指摘が来ているか確認し、どの順で対応していくかを決めます。
対応順については、この後に続けて書きますが、
- 軽微な内容への対応
- 中程度の内容への対応
- 高難度の内容への対応
の3ステップで進めるのがオススメ。
2. 軽微な内容に対応
次に、軽微な修正に取り組みます。
修正対応としては、1巡目となります。
まず、脳死で対応できるようなところを直しましょう。
例えば、
- タイポ
- 使用してないimportやメソッドの削除漏れ
- デバッグログの削除漏れ
などなど。
簡単なところから手をつけることで、後続の対応のハードル低くなり、進めやすくなります。
指摘を受けたけれど、対応しないものについても、この段階で返信しておくと良いでしょう。
修正時のGitHubの操作手順
ここで、修正時のGitHubの操作手順についてご紹介します。
この手のお話が不要な場合は、次の 3. 中程度の内容に対応 まで進んでください
まずローカル環境で修正し、該当箇所の対応が完了したら、コメントに返信します。
最初のコメントを入れる際、Start a reviewしてレビューモードにしておくべし！
対象のプルリクの「Files changed」タブ（①）にて、コメントを入力し（②）、「Start a review」 ボタン（③）を押すとレビューモードになります。
こうしておくと、対応途中にコメントを入れてもPending状態（④）となって「Submit a review」するまではレビュワーには見えなくなります。
ちまちまと通知が飛ぶことがなくなるので、レビュワーの方々への負担を減らせます。
なお、変更はすぐコミット&プッシュせず、キリのいいところまで対応してからにしましょう。
そうでないと、「Files changed」からレビュワーからのコメントが消えてしまう場合があり、コメント返信に手間取ることも。
レビューモード中にどうしてもレビュワーにコメントを見せたい場合は、「Conversation」タブまで移動し（⑤）、
一番下の「Add a comment」欄に入力の上（⑥）、「Comment」ボタンをクリック（⑦）すればOKです。
3. 中程度の内容に対応
続いて、修正対応としては、2巡め、中程度のレベルの内容に対応します。
この中程度と、後続の高難度の区分けは自身の肌感でOK。
時間のかかりそうなもの、この時点でなんとなく気が進まないものは思い切って後回しにしちゃいましょう。
4. 高難度の内容に対応
そして、修正対応としては最後の段階の3巡目。
残りの対応を全て片付けます。
5. 対応コメントの見直し
一通り修正が完了したら、対応コメントを見直します。
2〜4に対応する中で、該当箇所が消えたり、実装が変更になっているケースがあるからです。
対応当初と内容が変わっている場合は、コメントの内容を変更しておきましょう。
6. Submit a review（完了報告）
最後に、対応が完了した旨のコメントを入れ、「Submit a review」して完了です！
修正完了後のGitHubの操作手順
修正完了後のGitHubの操作手順についても書いておきます。
まず、「Files changed」タブに移動し（①）、「Review changes」をクリック（②）
Finish your reviewのコメント欄に入力し（③）、「Submit review」をクリック（④）
これによって、レビューモードが解除され、Pendingとなっていたコメントがレビュワーに見えるようになります。
まとめ
大量のレビューコメントを受けると焦りがちですが、段階的に対応していけば着実に進められます。
合わせて、日々技術レベルや実装内容を改善し、少しでも指摘を減らせるようにしていきたいですね。