【Git】Gitのコミットメッセージテンプレートをグローバルに適用する

はじめに

普段使っているコミットメッセージテンプレートを色々なプロジェクトで流用したいと思った時のメモです。

設定方法

1. ルートディレクトリにテンプレート用ファイルを作成する

テンプレートは絵文字とステータスを組み合わせたものにしました。

.gitmessage.txt

# ==================== Format ====================
type: Subject

# ==================== Types ====================
# ✨ feat: 新機能
# 👍 update: 機能改善
# 🐛 fix: バグ修正
# 💎 style: コードの意味に影響しない変更（空白、書式、セミコロンの欠落など）
# 🧹 refactor: バグの修正でも機能の追加でもないコード変更
# 📚 docs: ドキュメントのみの変更
# 🚀 perf: パフォーマンスを向上させるコード変更
# 🚨 test: 不足しているテストの追加や既存のテストの修正
# 🛠 build: ビルドシステムや外部の依存関係に影響する変更 (スコープの例: gulp, npm)
# ⚙️ ci: CI の設定ファイルやスクリプトの変更 (スコープ例: Travis, Circle)
# ♻️ chore: src やテストファイルを変更しないその他の変更
# 🗑 remove: ファイル/コード削除
# 🗑 revert: 以前のコミットを取り消す

（いつも思うけど⚙️と♻️だけ色ついてくれないの寂しい）

2. パスを通す

グローバルに設定するようにパスを通します。

git config --global commit.template ~/.gitmessage.txt

3. さらにプロジェクト配下でパスを通す

グローバルのテンプレートのパスを通します。
プロジェクト内に指定のコミットメッセージテンプレートがあれば、そちらが優先されます。

git config commit.template ~/.gitmessage.txt

4. 完成

IDE内で使えるようになりました🎉

おわりに

コミットメッセージのテンプレートがあることによって、コミットする時に内容を意識できるので個人的には好きです。
複数人で開発する時にはプロジェクトでルールを決めるのもよいと思いますが、個人の範囲なら全プロジェクトでその時のベストテンプレートをするのも便利だな〜と思いました。