チーム開発においてコミットを駄ミットメッセージにしないために気をつけたいこと

概要

今年はコミットメッセージを気をつけたいと思い記事にしました。

レビュー指摘修正やfixとだけは書くのやめよう。

失敗例)

fix: レビュー指摘修正

理由は何を意図した実装かわからなくなるから。
指摘があったということは必ず理由があるはずなのでなぜそう直したかを書く方が良いです。
また複数あった場合は理由ごとにコミットを分けた方が良いと思います。

例)

fix: typo修正
fix: 小数点の丸め処理を切り捨てにした
refactor: 〇〇を使うようにした

トーンマナーから外れた絵文字コミット、プレフィクス無しのコミットは避けよう。

失敗例)

⚪︎⚪︎⚪︎⚪︎⚪︎⚪︎の🐞修正

ガイドラインがあれば一読すべきですが、大抵用意されていないのでプロダクトごとに過去のコミットの傾向を見てどんなメッセージがあるのかみておきましょう。
もしプレフィクスをつけるルールがあったら倣うべきだし、マイルールで絵文字を使う人の場合はそのプロダクトでそのメッセージが受け入れられるのか一度考えた方が良さそうです。

プレフィクスを意識してコミットメッセージを書こう。

これはfeat、これはchoreなど意識するとコミットの粒度が適切になるので一度はやってみた方がいいです。