[Git] コミットメッセージフォーマット

2 min read
hiroweb developer

プレフィックスを付けるようにしているが、fix:〜とかadd:〜としているものの、なかなか定まらない。(調べてみたが、きれいな書き方が定まらない…)

通常版

  • fix:バグ修正
  • hotfix:クリティカルなバグ修正
  • add:新規(ファイル)機能追加
  • update:機能修正(バグではない)
  • change:仕様変更
  • clean:整理(リファクタリング等)
  • disable:無効化(コメントアウト等)
  • remove:削除(ファイル)
  • upgrade:バージョンアップ
  • revert:変更取り消し

絵文字

コミットコメントに基づいた関連する絵文字。

  • fix:バグ修正
    • 🐛
    • 🪲
    • 🩹
    • 🔧
  • hotfix:クリティカルなバグ修正
    • 🚑
    • 🔥
    • 🆘
  • add:新規(ファイル)機能追加
    • 🆕
    • 📝
  • update:機能修正(バグではない)
    • 🛠️
    • ✏️
    • ⚙️
    • 🔄
  • change:仕様変更
    • ♻️
    • 🔄
    • 📈
    • 📐
  • clean:整理(リファクタリング等)
    • 🧼
    • 🧽
    • 🧹
    • 💅
  • disable:無効化(コメントアウト等)
    • 🚫
    • 🔇
  • remove:削除(ファイル)
    • 🗑️
    • 🧻
  • upgrade:バージョンアップ
    • ⬆️
    • 🆙
    • 🚀
    • 📈
  • revert:変更取り消し
    • ↩️
    • 🔄
    • 🚫

ライト版

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

参考

🎨 :コードのフォーマットや構造を改善した
🐎 :パフォーマンスを改善した
🚱 :メモリリークを修正した
📝 :ドキュメントを書いた
🐧 :Linux 環境固有の問題を修正? (fix something on Linux)
🍎 :Mac 環境固有の問題を修正?
🏁 :Windows 環境固有の問題を修正?
🐛 :バグを修正した
🔥 :コードやファイルを削除した
💚 :CI に関する修正
✅ :テストを書いた
🔒 :セキュリティ関連
⬆️ :dependencies (依存ライブラリ?) をアップグレードした
⬇️ :dependencies をダウングレードした
👕 :lint の警告を remove した (lint で警告されていたところを修正した、の意?)

ref: https://dackdive.hateblo.jp/entry/2016/07/06/093000
ref: https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages

参考