🙆

Git GitHub gitmoji

2023/10/21に公開

✨ はじめに

この記事では、Gitのコミットメッセージに絵文字のプレフィックスを追加する方法を説明します。
これにより、コミットログが見やすくなり、変更内容を一目で把握できるようになります。
最近ではMojoが拡張子に🔥を使えるようになってたりと、世界的に絵文字が受け入れられていますね。

例:絵文字のプレフィックスをつけたプロジェクト画面。
image.png

👍 絵文字をコミットメッセージに追加する利点

絵文字をコミットメッセージに追加することで、次のような利点があります。

  • コミットの内容が一見してすぐに分かる
  • 見た目が楽しい
  • カテゴライズのためにコミットを分割するようになる

📒 絵文字をコミットメッセージに追加する方法

やり方は非常に簡単で、:{絵文字名}: をコミットメッセージに入力するだけです。
例:

git commit -m ":bug: バグ修正"

💡 どの絵文字を使うべきか

gitmojiというサイトで絵文字とコミット種別の対応が定義されています。

https://gitmoji.dev/

数が多いので、よく使うgitmojiを以下に記します。
(表示制限の都合で一部絵文字はブログでは白黒になっています)

:tada: プロジェクト開始 🎉
:bug: バグ修正 🐛
:sparkles: 新機能の追加 ✨
:zap: 機能追加 ⚡️
:memo: ドキュメントの追加・修正 📝
:recycle: リファクタリング ♻️
:fire: 不要機能やファイルの削除 🔥
:construction: 作成途中のコミット 🚧

あまり完璧に分類することには拘らず、まず使いやすい数個から気軽に使っていきましょう。
特にチームで適用する場合、分類や間違えの指摘を厳密にしすぎてしまうと、かえって開発がやりにくくなります。

🍪 おまけ:VSCodeプラグインの利用

gitmojiを覚えるまでは、以下のようなプラグインを使うと便利です。

https://marketplace.visualstudio.com/items?itemName=seatonjiang.gitmoji-vscode

以下のような感じで、簡単にgitmojiを選択することができます。
gitmoji.png

🚀 最後に

絵文字を使うことで、Gitのコミットログが一目で理解でき、開発がより楽しくなります。
ツール導入の必要もなく、誰でも簡単に試せますので、ぜひ使ってみて下さい。

Discussion