コミットメッセージのプレフィックスまとめ
開発を進める上で、コミットメッセージは大切!
自分や他の開発者が「何をしたのか」一目でわかるように、共通のフォーマットで整理してみました。
迷ったときにすぐ見返せるように、ここに自分向けメモを残しておきます!
プレフィックス一覧
プレフィックス | 意味 | 使うタイミング |
---|---|---|
fix | バグ修正 | エラーや動作不良の修正をしたとき |
add | 新しい機能・ファイルの追加 | 新しく作った機能やファイルを追加したとき |
update | 既存機能の修正(バグではない) | バグじゃないけど、ちょっと改良したり仕様変更したとき |
remove | 不要なものを削除 | 使わなくなったファイルやコードを削除したとき |
プレフィックスの具体例
-
fix: 不具合を見つけて修正したときに使う!
- 例:
fix: ユーザー認証が失敗する問題を修正
- 例:
-
add: 新しいページや機能、コンポーネントを作ったときに使う!
- 例:
add: ユーザー登録ページを追加
- 例:
-
update: 既存の機能を改善したり、少しだけ変えたときに使う!
- 例:
update: プロフィール編集ページのレイアウトを調整
- 例:
-
remove: いらなくなったコードやファイルを消したときに使う!
- 例:
remove: 不要になったテストファイルを削除
- 例:
まとめ
プレフィックスを使い分けておくと、後で見返したときに「何をやったか」がすぐにわかるし、レビューも楽になる!
特に複数人でやってると、こういうルールがあるとみんなハッピー
自分も未来の自分にやさしくなるためにこれを守っていこ