Git で Emoji Prefix に関してのメモ

プログラミング

はじめに

Git リポジトリに Emoji Prefix のコミットテンプレートを設定してみる。

Emoji Prefix を導入するメリットは

  • 絵文字とコミットが対になるので、コミットの役割が明確になる
    • バグ修正＋リファクタリング＋機能追加。。。など本来分割すべきコミットがごちゃごちゃ一緒になることを防げる
  • コミットログのプレフィックスに絵文字がつくため、ログの可視性が上がる
  • 明るい絵文字を使うとプロジェクトが殺伐としづらくなる作用

コミットテンプレートを用意する

今回は以下のコミットテンプレートを用意した。

commit-template.txt

# EMOJI PREFIX
# 🆙 : Version up
# ⚡️ : Add major feature.
# ✨ : Add feature.
# ♻️ : Refactoring
# 🔧 : Improve Performance
# 🐛 : Fix Bug
# 🧹 : Remove unsed feature / resource.
# 🎨 : Update resources.

リポジトリにコミットテンプレートを設定する

# config にテンプレートを設定する
$ git config --local commit.template commit-template.txt

# テンプレートが設定されているかを確認する
$ git config --local commit.template
commit-template.txt  # 問題なく設定されていた

でリポジトリにテンプレートを設定する。ここでは対象範囲を local にしている。

  • config の対象範囲は以下になる。
    • local : リポジトリ単位
    • global : ユーザー単位
    • system : すべて

コミットテンプレートが設定されているか確認

$ git commit

をすると、下のようにテンプレートが表示されたので OK

f:id:daisuke-t-jp:20190824103753p:plain:w500

  • TODO
    • GitHub Desktop からコミットテンプレート使うには？

参考