コミットメッセージの書き方について

ども、ラボ開発部のカロージです。
Gitのコミットメッセージの書き方について、ちょっとまとめてみたので共有させて頂きます。
コミットメッセージの書き方に特に正解はないのですが、Gitを使ってチーム開発する上でコミットメッセージは必須なため、チームでルール化する上での一つの考え方としてご参考になればと思います。

コミットメッセージで「update」「 bugfix」 など適当になってませんか?
コミットメッセージが適当だと、プルリクでソースレビューする際などコードを追うのが難しくなります。
反対にコミットメッセージが分かりやすいとソースコードの変更箇所のあたりがついたり、意図がくみ取れるため修正箇所の理解や、指摘が早かったりします。

 

1.結論
2.カテゴライズする
3.理由を記述する

 

 

1.結論

以下の様に記述します。

 

2.カテゴライズする

以下の様なプリフィックスを指定しカテゴライズする形で記述します。
カテゴリ種類があまり多いとカテゴライズが煩雑になるので、以下くらいに抑えます。

  • bugfix : バグ修正
  • add : 新規(ファイル)機能追加
  • update : 機能修正(バグではない)
  • remove : 削除(ファイル)
  • other : その他

 

3.理由を記述する

理由を明記するだけでレビューする箇所やポイントが絞られ、作業の効率化が図れます。
また、コミットメッセージは、日本語でも英語でもOKですがリポジトリで統一した方が良いと思います。

 

でわ



❏❏ TOPIC ❏❏ ------------------------------------------------------------

カスタム自由!フリーECサイトパッケージ
チャットボット導入サービス
WEBシステム開発・スマホアプリ開発はSRIAへ