GitのコミットメッセージにつけるPrefixのまとめ

コミットメッセージの先頭にPrefix(接頭辞)をつけることで、コミットのカテゴリーを瞬時に判別することができます。

この記事では筆者が日常的に使用しているPrefixを紹介しています。
ただし、使い方は個人の裁量によるところが大きいため、業務に導入する際はチームや開発スタイルにあわせて柔軟に設定することをお勧めします。

feat

featureの略。ユーザー向けの機能の追加や更新の際に使用します。
(内部的な機能追加のみのコミットには付きません)

feat: タイトルロゴを更新 など

fix

ユーザー向けのバグ修正の際に使用します。

fix: コメントフォームの必須項目を修正 など

refactor

文字通り、リファクタリングのコミットに使用します。

refactor: CSSプロパティの順番を統一 など

build

内部的な更新の際に使用します。

build: ライブラリのバージョンを変更 など

perf

performanceの略。パフォーマンス向上のための修正に使用します。
(refactorも兼ねている場合、比重がどちらに寄っているかで決めます)

perf: SQLクエリを修正 など

test

テストファイルの追加などに使用します。

test: Homeコンポーネントのユニットテストを追加 など

style

コーディングフォーマットの修正に使用します。

style: コード内の不要な改行を削除 など

docs

documentsの略。ドキュメントの追加・更新に使用します。

docs: READMEに依存ライブラリのバージョンを記載 など

chore

その他、雑務的なコミットに使用します。

chore: gitignoreを更新 など

 

以上となります。是非参考にしてみてください。

コメント

タイトルとURLをコピーしました