レビュー箇所を修正するときってマナーとか決まりあるのかな?
普段、細かいことを気にせずPRのレビューに対応していましたが、ふと詳しく調べてみるとマナーや決まりが存在するみたいでした。今まで知らずに速さだけを求めて修正対応していたのが申し訳ない...。ということで自戒としてまとめていきます!
レビュイーの対応の流れ
レビューを受ける対象者である「レビュイー」の修正対応の流れをまとめます。
原稿を修正してコミット&プッシュ
行に対するコメントを確認し、一つずつ原稿を修正していきます。
このとき、一つの行コメントに対して一つのコミットを作成することを心がけます。
リモートへの反映を確認
先ほどプッシュした変更がリモートに反映されているか、Github上で確認します。
PRの「Commits」に各コミットが正常になされているかどうか、確認していきます。
行コメントにて修正完了を返信
レビューしていただいた箇所に対して、修正完了のコメントをしていきます。
この時、Add Single Commentよりも、Add a Reviewの方が、複数のコメントを一括で相手側に知らせることができるので、今後使ってみようと思いました!
修正完了のコメントに関しては、絵文字やびっくりマークを使用する方が相手側に良い印象を与える気がしています。
また、行コメントを入れる場合はコミット番号のリンクを貼り付けておくと、レビュアーさんも追いやすいので親切ですね!
レビュイー側の対応ポイント
レビュイーさんが心がけること、いくつかポイントがありそうだったのでまとめておきます。
一つの行コメントに対し、一つのコミットで修正
指摘の修正ごとにコミット内容を分けると、レビュアー側も修正の確認がしやすく、再レビューがスムーズになります。まとめたものがいいものもあるので、そこは自己判断ですね!
「指摘の存在」より「指摘の内容」をコミットコメントに残す
「コミットコメント=変更の歴史」です。
稀に「指摘箇所を修正」というコメントも見受けられますが(元ヘビーユーザー)、これでは「この変更で何が起こったのか」把握しにくいですよね。
「指摘がされたこと」を明示するコメントではなく、「指摘を受けて変更した内容」をコミットコメントとして残すようにしていきましょう。
まとめ
自分がレビュアーである場合、自分がレビュイーである場合、度ちたの立場でも相手のやりやすさを想定して動くことができると、双方気持ちよく仕事をすることができますね!

