🌏

[ Git ] コミットメッセージを見やすくするならこれ一択

2025/02/04に公開

コミットメッセージは個性が出やすい...

コミットメッセージは コードの変更履歴を追跡する上で非常に重要な役割を果たしています
パッと見た時に「概要」だけでも分かると嬉しいですよね〜〜

...でもプレフィックスについての紹介記事読んでると、
とにかく種類が多い...!見やすさに欠ける可能性もありますし
このプレフィックスどういう意味?と第三者がなったら本末転倒です。

なので、この5つあれば耐えるのではないかというものをまとめます。

見返した時にすぐに使えるように先にパーッと書く

fix : バグ修正
add : 新機能の追加
update : 既存機能の更新
remove : 不要なコードの削除
refactor : コードのリファクタリング

fix: バグ修正

fix は、バグやエラーを修正した際に使用します

fix : ユーザー登録時のバリデーションエラーを修正
fix : 商品一覧の並び順が正しく適用されない問題を解決

add: 新機能の追加

add は、新しい機能やファイルを追加した際に使用します

add : ユーザープロフィール編集機能を実装

update: 既存機能の更新

update は、既存の機能やファイルを更新した際に使用します

update : ログイン画面のUIを改善
update : ライブラリのバージョンを更新

remove: 不要なコードの削除

remove は、コードやファイルを削除する際に使用します

remove : 使用していない古いAPIコードを削除
remove : 非推奨となった機能を削除

refactor: コードのリファクタリング

refactor は、機能は変えずにコードの構造を改善する際に使用します。

refactor : 変数名をより分かりやすい名称に変更

コミットメッセージで意識していること

自分だけが理解できても意味がないので、
小さなストレスを軽減していくためにも "わかりやすさ" を意識しましょう🙆‍♀️

Discussion