Tl;Dr
Suggestion(Cmd + g) で修正提案のコメントができ、
取り込む人は diff を確認し、 Commit suggestion からボタン一つでコミットして取り込める。
追記:2020/02/27
まだ、ベータ段階だが複数行の修正提案にも対応された。
Suggestion Change
冒頭のようにsuggestion
をつけたコード形式で記述すると、修正提案という形でコメントできる。
単純なtypo
であればこのままコメントしても伝わるだろうし、補足したいことがあれば冒頭のように説明を追加することも出来る(これが適切な例かは別として)。
取り込む人は diff を確認してボタン一つでコミットできるし、レビュアーは自身のコメントが取り込まれていることを確認するだけでよいので、双方の負担軽減につながる。
コミットをまとめる
特に Push トリガーで CI を実行している場合において、複数の修正提案を一つずつコミットすると、コミット単位で CI が実行されてしまい煩雑なことがある。
その場合は Add suggestion to batch からコミットをまとめることができ、
補足
この機能に限った話ではないが、リモート側でコミットされるので、ローカルでも合わせて修正をする場合は git pull
するのを忘れないようにする必要があるので注意。
もし修正がコンフリクトしないなら git pull --rebase
が手っ取り早い。
終わりに
この内容に相当する記事は、半年くらい前に会社の Qiita::Team でも書いており、Qiita にも書こうと思いながら半年以上も経過してしまった;
レビューイ・レビュアーの双方の負担を減らす、良き PR レビューライフを。