[初心者向け]Gitのコメントログのテンプレートをササッと見たいよね。

コミットログのサンプルが見たいのよ。

突然ですが、gitでいい感じにコミットログを残したいと思いませんか。

私はターミナル派なのでgitのコマンドもターミナルからバシバシ打ち込みます。
しかし、いい感じのコミットログをさらっと打ち込むことができません。
絵文字使いたいけど、、覚えていません。なので検索したり過去コミットからコピーしたりです。

コマンドでコミットログのサンプルがササッと見れればいいのになと思ったのです。

すぐに見れるように作りました。

.bash_profile

function git-m {
  echo "# ==================== Emojis ==================== "
  echo "# 🎉  :tada: 初めてのコミット（Initial Commit） "
  echo "# 🔖  :bookmark: バージョンタグ（Version Tag） "
  echo "# ✨  :sparkles: 新機能（New Feature） "
  echo "# 🐛  :bug: バグ修正（Bugfix） "
  echo "# ♻️  :recycle: リファクタリング(Refactoring) "
  echo "# 📚  :books: ドキュメント（Documentation） "
  echo "# 🎨  :art: デザインUI/UX(Accessibility) "
  echo "# 🐎  :horse: パフォーマンス（Performance） "
  echo "# 🔧  :wrench: ツール（Tooling） "
  echo "# 🚨  :rotating_light: テスト（Tests） "
  echo "# 💩  :hankey: 非推奨追加（Deprecation） "
  echo "# 🗑️  :wastebasket: 削除（Removal） "
  echo "# 🚧  :construction: WIP(Work In Progress) "
  echo " "
  echo " "
  echo "# ==================== Format ==================== "
  echo "# :emoji: Subject "
  echo "# "
  echo "# Commit body... "
}

.bash_profileあたりにこれをコピーしてもらえればすぐに利用することができます。

$ git-m
# ==================== Emojis ====================
# 🎉  :tada: 初めてのコミット（Initial Commit）
# 🔖  :bookmark: バージョンタグ（Version Tag）
# ✨  :sparkles: 新機能（New Feature）
# 🐛  :bug: バグ修正（Bugfix）
# ♻️  :recycle: リファクタリング(Refactoring)
# 📚  :books: ドキュメント（Documentation）
# 🎨  :art: デザインUI/UX(Accessibility)
# 🐎  :horse: パフォーマンス（Performance）
# 🔧  :wrench: ツール（Tooling）
# 🚨  :rotating_light: テスト（Tests）
# 💩  :hankey: 非推奨追加（Deprecation）
# 🗑️  :wastebasket: 削除（Removal）
# 🚧  :construction: WIP(Work In Progress)


# ==================== Format ====================
# :emoji: Subject
#
# Commit body...

いい感じです。
お好みのテンプレートに編集するのも簡単です。
コミット時のルールがあればそれも追記とかすればいいかと思います。

gitにはコミットテンプレートあるよ。

gitにはコミットログのテンプレートを用意する方法があります。

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

ですがこれだとプロジェクトごとにテンプレートを用意したりと大変です。
フロントやバックエンドでプロジェクトが別れている場合もあります。
なので、自身のマシンに設定してしまいましょう。

そうすると簡単にコミットログのテンプレを確認することができます。
表示してコピーして利用です。

お手軽ですね。

簡単ですがコミットログをササッと確認するための方法でした。