はじめに
今回ほぼ初めて案件に入ることになり、他メンバーと共同で作業をすることになったので相手を気遣ったgithubの使い方を覚えていく。
とにかく思いやり。
PR(プルリクエスト)の内容を記載する
どういった点を確認してほしいか、どのような変更があるのかを理解してもらうために内容は必ず記載する。
Issue の記載
Issueに課題を書いてある場合はそこのリンクに紐づくように、#数字で書いてあげることでリンクでIssueへ飛べるようになるので書いてあげると親切
概要の記載
項目名はなんでも良いが、わかりやすく概要などとしてあげる。
- 今回のPRで何を見てほしいか
- PRを出した理由など
ルールはないと思うが、できるだけわかりやすく書いてあげると良さそう。
確認方法
テストだったりをPRしてもらいたい場合は、具体的なコマンドなど貼ってあげると親切。
レビュー観点
具体的に何をレビューしてもらいたいか記載してあげると親切。
また対象ファイルなど細かくあるようなら、ここにマークダウンなどを使ってファイル名を書いてあげる。
その他
上記に書ききれない場合だったり、あえて分けたい場合はその他などにまとめてあげると良さそう。
マークダウン形式で書くことができるので、段落を分けてあげたりとわかりやすく書いてあげることが重要。
PRの指摘に関する修正時のコメントの書き方
修正後の差分がわかるようにリンクを貼ってあげる
PRを出したあと修正が入ってくると思うが、このときだた「修正しました」とかだけだと、どの箇所が修正されたか差分がわからない。
コミット・プッシュをしてあげるとgithubのCommits箇所に新たにプッシュされた変更コードが反映されるので、そこのコミット詳細をコピーして添付してあげる。そうするとリンクが作成されるので、一発で対象箇所の差分へ飛ぶことができ、レビュアーの労力をへらすことができる。
なるべく1つの指摘毎にコミット・プッシュする
上記にあげた部分は1つのコミットごとに作成がされます。
なので1つのコミットにいろんなファイルの修正がされていると結果ごちゃごちゃしてしまいます。
レビューワーの方がわかりやすいようにできる範囲でコミットをわけるようにしましょう!
最後に
レビュワーは常にいろんな案件を抱えている可能性があるので、レビューをしてもらう上で極力労力を割かせないように気を配ってあげる必要がある。
書き方をマスターして常にわかりやすいPRを出せるようになりたいですね。
以上