TL;DR
- Gitmojiとはコミットメッセージの先頭に絵文字をつけること
- VSCodeの拡張機能を使えば簡単に始められる
- Gitmojiを使うとコミットメッセージを一覧したときにわかりやすくなる
Gitmojiとは？
Gitを使ってファイルのバージョン管理をする時にもちろんコミットメッセージを書くと思いますが、これを見やすくする目的で先頭に絵文字をつける文化をGitmojiと言います。
これをチームで何の絵文字を使うか共通化しておくと、リポジトリのコミット履歴全体を把握しやすくなります。
環境
長いので折りたたみました。
環境一覧
Mac本体
OS: macOS 14.1.1 23B81 arm64
Host: Mac14,2
Kernel: 23.1.0
Uptime: 4 days, 1 hour, 12 mins
Packages: 31 (brew)
Shell: zsh 5.9
Resolution: 2560x1440
DE: Aqua
WM: Quartz Compositor
WM Theme: Blue (Dark)
Terminal: iTerm2
Terminal Font: UDEVGothic35NFLG-Regular 16
CPU: Apple M2
GPU: Apple M2
Memory: 4530MiB / 24576MiB
VSCode
バージョン: 1.84.2 (Universal)
コミット: 1a5daa3a0231a0fbba4f14db7ec463cf99d7768e
日付: 2023-11-09T10:52:33.687Z
Electron: 25.9.2
ElectronBuildId: 24603566
Chromium: 114.0.5735.289
Node.js: 18.15.0
V8: 11.4.183.29-electron.0
OS: Darwin arm64 23.1.0
VSCodeでの導入\
こちらの拡張機能を用います。
とりあえずインストールしたらすぐに使えます。
ソース管理タブのコミットボタンの上側にニコちゃんマークがあるのでそれを押すと簡単に目的の絵文字を選択できます。
チームでの共通化
デフォルトだとちょっと絵文字がありすぎて困るので、チーム内でこれだけ！って限定したい時もあると思います。そのような時はこんな感じでsettings.jsonに書けば使う絵文字を絞れます。私たちのチームは結構絞ってこんな感じで運用しています。
settings.json
{
"gitmoji.addCustomEmoji": [
{
"emoji": "🐛",
"code": ":bug:",
"description": "バグ修正・誤字脱字修正"
},
{
"emoji": "✏️",
"code": ":pencil2:",
"description": "微修正"
},
{
"emoji": "✨",
"code": ":sparkles:",
"description": "新機能・新ファイル追加"
},
{
"emoji": "🎉",
"code": ":tada:",
"description": "新プロジェクト立ち上げ"
},
{
"emoji": "⚡️",
"code": ":zap:",
"description": "改良・高速化"
},
{
"emoji": "♻️",
"code": ":recycle:",
"description": "コード整形"
},
{
"emoji": "💩",
"code": ":poor:",
"description": "非推奨追加"
},
{
"emoji": "🗑️",
"code": ":wastebasket:",
"description": "削除"
},
],
"gitmoji.onlyUseCustomEmoji": true,
}
すっきりしました。
あとはREADME.mdとかに絵文字の割り当て方法の詳細を書いて、チーム内で共通認識を持てばOKです。
しばらく運用してみた感想
チーム内で運用した感じ結構いい感じです。何よりも、メンバーが今日何をやったのか、バグ潰しに時間を食われたのか新機能を作っていたのかが一発でわかるようになるのが非常にいいです。
ただGitmojiをつけ忘れてCommitしてからPushすると非常に萎える（悪目立ちする）のでそこは注意しないといけないなって思ってます。