- GitHubのPRのコードレビューではsuggestionという、PRの差分に対して変更を提案する機能がある
- レビュイーは、レビュワーからのsuggestionを1つずつ適用(コミット)するのと、複数個まとめて適用することができる
- レビュワーがsuggestionする時、例えば変数名のtypoの修正提案では、変数名の定義箇所だけsuggestionすることもあれば、変数の利用箇所の方も合わせてsuggestionすることもある
- 利用箇所も合わせてsuggestionするのは、別々にコメントすることになるので数が多いと手間だし、PRのコメント数も増えて見通しが悪くなる
- ので定義箇所だけsuggestionしておいて、利用箇所も合わせて手元で直してください、という意図の時がある
- レビュワーとしては、この時のsuggestionはそのままGitHub上で適用されることを意図していない
- もしレビュイーがひとまずそのsuggestionを適用して、続きの修正を手元で行ってコミットしようとする時、最初のsuggestionだけのコミットはビルドが通らなかったり実行時エラーになる不完全なコミットになってしまう
- ので、こういう時は直接suggestionを適用せずに、関連箇所も一緒に直すようでありたい
PRのラインコメントが付いたまさにその箇所だけではなく、周辺のコード・PR内の別の差分についても意識したい・されたい、ということを考えていた最近です。