Gitのコミットメッセージ

Semantic Commit Messages を定義した方がいるため、こちらを参考にコミットメッセージのテンプレートを作成する。Conventional Commits に絵文字を追加したようなルールになっているのでコミットをしたときに絵文字がカラフルで見やすいのが特徴。

1. コミットメッセージテンプレートを作成する

適当なところに下記のファイルを作成する。

.gitcommit_template

# ==== Commit Messages ====

# ==== Commit Messages(Template) ====
# <Prefix> <Emoji> #<Issue Number> <Title>
# 例) feat :sparkles: #777 ログイン機能を実装

# ==== Prefix Emoji ====
# feat: :sparkles: 機能の追加や変更
# docs: :memo: ドキュメントの更新
# fix: :bug: バグ修正
# refactor: :recycle: リファクタリング
# test: :green_heart: テストコードの追加や修正
# chore: :building_construction: ビルドツールの導入や依存関係を更新など

github に push をするとこのようにコミットメッセージが表示されるようになる。
絵文字は以下から好きなものを引っ張ってくると良い。

• https://www.webfx.com/tools/emoji-cheat-sheet/

feat: ✨ 機能の追加や変更
docs: 📝 ドキュメントの更新
fix: 🐛 バグ修正
refactor: ♻️ リファクタリング
test: 💚 テストコードの追加や修正
chore: 🏗️ ビルドツールの導入や依存関係を更新など

2. 作ったテンプレートを git と連携させる

~/.gitconfig

[commit]
    template = ~/.gitcommit_template

使い方

$ git commit
# -m(--message)でワンラインで記述をするとテンプレートが発動しないため注意

# ==== Commit Messages ====

ここにコミットメッセージを入力する
feat :sparkles: #777 ログイン機能を実装

# ==== Commit Messages(Template) ====
# <Prefix> <Emoji> #<Issue Number> <Title>
# 例) feat :sparkles: #777 ログイン機能を実装

# ==== Prefix Emoji ====
# feat :sparkles: 機能の追加や変更
# docs :memo: ドキュメントの更新
# fix :bug: バグ修正
# refactor :recycle: リファクタリング
# test :green_heart: テストコードの追加や修正
# chore :building_construction: ビルドツールの導入や依存関係を更新など