#コミットとプルリクに書くこと決まってる?
開発をするのに避けて通れないのが、コミットとプルリク(マジリク)です。
新人であってもベテランであってもしないといけませんが、どんな書き方をするか決まっていますか?
個人個人で書くことがバラバラだったり、必要な情報が入っていないと書き手にもレビュワーにも負担がかかってきます。
書き手が意図していることがレビュワーにしっかり伝わること
また、レビューをしやすくするようなものにできると開発もスムーズに進むと思います。
一つ使えそうなお作法をまとめたので、良さそうだと思ったらプロジェクトに導入することをぜひ検討してみてください!
#コミットメッセージにプレフィックスを
####プレフィックスを先頭につけよう!
プレフィックスを見れば、一目でどんな種類の修正かが分かるし、統一感がでます!
add: 新規機能の追加
ref: 機能の修正
del: 機能の削除
fix: バグ修正
#プルリクに書くこと
コミットメッセージには書ききれなかったことや詳細を記載しましょう!
よくあるのは実装の概要を記載することかなと思います。
それ以外だと
レビューコメントにラベルをつけるだけで開発効率があがって幸せになれそうな話
からの引用ですが、下記を記載しても良さそうです。
本文には以下のようなことをMarkdownの見出しにして書くと便利です。
・目的
・達成条件
・実装の概要
・レビューして欲しいところ
ここはこうしたけどこの点で問題はないだろうか
このあたりいじってるけど特に悪いことはないか
・不安に思っていること
何をレビューしてほしいかを書こう
設計や企画のレビュー
・保留してること
このプルリクでしないこと
レビューの範囲を絞れる
・スケジュール
マージすべき日、リリースすべき日の指定があれば書く
・関連
関係するプルリクエスト
#まとめ
コミットメッセージにプレフィックスをつけるだけでもかなり効果があると思います。
ここで紹介した以外のプレフィックスをオリジナルで作って使ってもいいですし、プロジェクトを進めるのに最適なやり方を見つけてもらえればと思います。
他にいいやり方があればコメントもらえると嬉しいです!
#おまけ:レビュワーが書くといいコメント
指摘をするときにもプレフィックスをつけると分かりやすい!
[MUST] 必ず対応してほしい!
[IMO] 自分の意見や提案・好み。 自分ならこう書くけどどうかな?
[NITS] 些細な指摘。 ほんの小さな指摘だけど出来れば直してほしい。インデントやタイポ
[ASK] 質問,確認。 コードの意味や背景が分からないから教えて!こういう理解でOK?
[例] [MUST]変数dataにはnullかどうかチェックを入れて欲しい!
##参考URL
・Gitのコミットメッセージの書き方
・レビューコメントにラベルをつけるだけで開発効率があがって幸せになれそうな話