🌈

【gitmoji】シンプルな絵文字付きコミットメッセージを考える

2025/02/24に公開

課題感 (gitmojiイケてない感)

  • コミットログの探索速度を高めたい (ロールバック先の選定、開発進捗の把握 等)
  • コミットメッセージに絵文字を用いることで、一目で各コミットの性質が分かり、視認性が高まる
  • gitmojiという有志により標準化された絵文字のルールがあるが、以下の課題がある
    1. 絵文字の選択肢が多いため、選択負荷が高い
    2. 各絵文字の意味づけがMECEでないため、統一的な運用になりにくい

やりたいこと

  • 誰でも迷わず選択可能な、シンプルなコミットメッセージ用の絵文字集合を定義する
  • gitmoji VSCode拡張向けの設定ファイルを作成する

gitmoji
VSCode上でのコミットメッセージ入力時に、GUIから絵文字を選べるようにする

gitmoji再定義

絵文字 説明 (日本語) 破壊的変更を含めてよいか
新機能の追加
♻️ リファクタリング
🐛 バグ修正
💄 見た目のみの修正
🚚 ファイルやディレクトリ名の変更
📝 ドキュメント更新
🔧 設定ファイルやスクリプトの更新
テストコード更新

策定方針

  • 互換性維持のため、gitmojiの定義を踏襲する
  • 数の少ないイレギュラーなコミットは定義せず、絵文字なしのコミットメッセージにて対応する
    例: 🚧=WIP, 🎉=最初のコミット

VSCode拡張設定

setting.json
{
    "gitmoji.addCustomEmoji": [
    {
      "emoji": "✨",
      "description": "新機能の追加"
    },
    {
      "emoji": "♻️",
      "description": "リファクタリング"
    },
    {
      "emoji": "🐛",
      "description": "バグ修正"
    },
    {
      "emoji": "💄",
      "description": "見た目のみの修正"
    },
    {
      "emoji": "🚚",
      "description": "ファイルやディレクトリ名の変更"
    },
    {
      "emoji": "📝",
      "description": "ドキュメント更新"
    },
    {
      "emoji": "🔧",
      "description": "設定ファイルやスクリプトの更新"
    },
    {
      "emoji": "✅",
      "description": "テストコード更新"
    }
  ],
  "gitmoji.onlyUseCustomEmoji": true
}

参考

Discussion