概要
GitHub の PR で編集されていない箇所にレビューコメントしたかったのですが、どうしてもできなかったため代替策を記録しておきます。
課題
GitHub で コードレビューをしていると、その PR 内で編集されていない箇所にコメントしたいことがあります。ですが PR では編集された近辺の行にしかコメントを追加できません。
コード編集箇所とその近辺では、青い＋マークが表示される
＋マークをクリックし、コメントを追加する
しかし編集箇所ではないところには＋マークが表示されずコメントできない
対策
基本
この場合、PR のコード内に直接コメントをできる方法はありません。そのため以下の代替手順でコメントを残すことにしました。
- View File を選択してファイルを開く
- 該当する行を選択して Copy permalink をクリック
- Conversation にコピーした URL を含めてコメント
- Request changes にコメントを書いて Submit review をクリック
View File を選択してファイルを開く
該当する行を選択して Copy permalink をクリック
複数行を選択するには、先頭行をクリック→末尾行をShift+クリックしてください
Conversation にコピーした URL を含めてコメント
Conversation にコピーした URL を含めてコメント
Request changes にコメントを書いて Submit review をクリック（自作自演 PR のため Request changes にチェックが入れられず）
レンダリングされるファイルの場合
Markdown や CSV などレンダリング表示されるファイルの場合、Copy permalink が選択できない場合があります。この場合はコード表示に切り替えることで同様の操作が可能です。
Markdown では Copy permalink などのメニューが表示されない
Code ボタンを押す事でコード表示に
GitHub Enterprise を使っている場合、Display the source blob という表示の場合があります。
Display the source blob を押せばコード表示に
まとめ
どの箇所をどのように直すべきか一目でわかるようにしてあげる事で、レビュアー/レビュイー間の齟齬がなくなり結果的に早く仕事が進みます。良いコードレビューを！