LoginSignup
581
616

Gitのコミットメッセージの先頭につけた方が良い単語リスト(prefix集)

Last updated at Posted at 2023-05-04

コミットメッセージで、先頭に接頭辞(prefix)を使うことで、コミットメッセージに含める情報を明確にすることができます。私は、初学者のため、このリストを忘れることが多いので、すぐに振り返ることができるように、記しておく。

接頭辞 説明
fix 既存の機能の問題を修正する場合に使用します。
hotfix 緊急の変更を追加する場合に使用します。
add 新しいファイルや機能を追加する場合に使用します。
feat 新しい機能やファイルを追加する場合に使用します。
update 既存の機能に問題がないが、修正を加えたい場合に使用します。
change 仕様変更により、既存の機能に修正を加えた場合に使用します。
clean/refactor コードを修正し、改善する場合に使用します。
improve コードの改善をする場合に使用します。
disable 機能を一時的に無効にする場合に使用します。
remove/delete ファイルを削除する場合や、機能を削除する場合に使用します。
rename ファイル名を変更する場合に使用します。
move ファイルを移動する場合に使用します。
upgrade バージョンをアップグレードする場合に使用します。
revert 以前のコミットに戻す場合に使用します。
docs ドキュメントを修正する場合に使用します。
style コーディングスタイルの修正をする場合に使用します。
perf コードのパフォーマンスを改善する場合に使用します。
test テストコードを修正する場合や、テストコードを追加する場合に使用します。
chore ビルドツールやライブラリで自動生成されたものをコミットする場合や、上記の接頭辞に当てはまらない修正をする場合に使用します。

文章でリストを表示(少し詳細あり)

fix: バグ修正

既存の機能の問題を修正する場合に使用します。

hotfix: 緊急対応

稼働中のシステムのバグ修正など、緊急性が高い修正を行う場合に使用します。

add: ファイルや機能の追加

新しいファイルや機能を追加する場合に使用します。

feat: 新機能・新規ファイル追加

新しい機能やファイルを追加する場合に使用します。

update: 機能修正

既存の機能に問題がなく、ただし修正を加えたい場合に使用します。

change: 仕様変更による機能修正

仕様変更により、既存の機能に修正を加えた場合に使用します。

clean・refactor: リファクタリング

コードを修正し、改善する場合に使用します。

improve: コードの改善

コードの改善をする場合に使用します。

disable: 機能の無効化

機能を一時的に無効にする場合に使用します。

remove: ファイルの削除・機能の削除

ファイルを削除する場合や、機能を削除する場合に使用します。

delete: ファイルの削除・機能の削除

ファイルを削除する場合や、機能を削除する場合に使用します。

rename: ファイル名の変更

ファイル名を変更する場合に使用します。

move: ファイルの移動

ファイルを移動する場合に使用します。

upgrade: バージョンアップ

バージョンをアップグレードする場合に使用します。

revert: 修正の取り消し

以前のコミットに戻す場合に使用します。

docs: ドキュメントの修正

ドキュメントを修正する場合に使用します。

style: コーディングスタイルの修正

コードのスペース、セミコロン、行などのスタ

perf: パフォーマンスの改善

コードのパフォーマンスを改善する場合に使用します。

test: テストコードの修正・追加

テストコードを修正する場合や、テストコードを追加する場合に使用します。

chore: その他の修正

ビルドツールやライブラリで自動生成されたものをコミットする場合に使用します。また、上記の接頭辞に当てはまらない修正をする場合にも使用します。


以上になります。

リストを記載しましたが、実際の実務になると、プロジェクトごとに異なるルールがある場合があるらしいので(私は実務未経験のため詳細はわかりません)、コミットメッセージのルールを十分に確認することが重要みたいです。

他にも良い方法があれば、コメントいただけると大変うれしいです。
良かったと思ったら、いいねやTwitterのフォローよろしくお願いいたします!

https://sites.google.com/view/muranakar
個人でアプリを作成しているので、良かったら覗いてみてください!

参考記事

581
616
7

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
581
616