LoginSignup
25
22

More than 5 years have passed since last update.

Gitのコミットに絵文字を使おう!

Last updated at Posted at 2017-05-30

✨はじめに

みなさん, Gitを活用にしていますか?
コードのログを管理し, 大人数での作成などでもすごく効果的に使うことが出来ます。
その中でコミットをこまめにすることを忘れがちになってしまうと思います。
そこで効果的なのがコミットメッセージに絵文字を使うことです。

🚀絵文字コミット

この絵文字コミットはAtomが正式にEmoji Prefixとしてルール化したことで有名です。
まずそれぞれのコミットに対してそれを表すEmojiを定義します。
(自分が使っているのはこんな感じです)

絵文字 文字列 意味
:art: art コードのフォーマットや構造にテコ入れ
:rocket: rocket パフォーマンスを改善
:pencil2: pencil2 ドキュメントを書いた時
:construction: construction 作業中
:heavy_plus_sign: heavy_plus_sign 機能を追加,完成
:heavy_minus_sign: heavy_minus_sign 機能を削除
:speaker: speaker ログを追加
:mute: mute ログを削除
:bug: bug バグ修正
:white_check_mark: white_check_mark テスト関係
:lock: lock セキュリティ関係
:exclamation: heavy_exclamation_mark 更新やTag付

そしてこれをコミットメッセージの前に一つだけつけます
それだけです。

導入すると写真のようになります。
image.png
(syuchan1005/SoundMEより)

これを導入する事によるメリットが多く存在します。

  • コミットがきれいになる
    例えば「機能の追加及びセキュリティの更新」をコミットしようとすると, それを表すEmojiはありません。
    Emojiをつけるためにはコミットを分ける必要があります。
    こうすることでわかりにくいコミットが減り, コミットの単位を揃えることが出来ます

  • コミットが見やすくなる
    そのコミットがだいたい何をしたかがわかりやすくなります。

などがあります

🎨便利に使うには

ターミナルでの操作には[参考ページ]内の[Emojiで楽しく綺麗なコミットを手に入れる]を見ていただけると丁寧に解説されています。

Jetbrains系IDE(IDEAなど)での場合

まず, EmojiPrefixというPluginを導入します。
Projectのルートディレクトリに[.emojirc]というファイルを作成し, 書き込みます。

書き込み例
art=コードのフォーマットや構造にテコ入れ
rocket=パフォーマンスを改善
pencil2=ドキュメントを書いた時
construction=作業中
heavy_plus_sign=機能を追加,完成
heavy_minus_sign=機能を削除
speaker=ログを追加
mute=ログを削除
bug=バグ修正
white_check_mark=テスト関係
lock=セキュリティ関係
heavy_exclamation_mark=更新やTag付

そして普通に[VCS] -> [Commit Changes]をクリックしコミットします。
image.png
するとこんな感じでダイアログがでます。
image.png
つけたいものを選択し(今回はrocket)[OK]をクリックします
するとしっかりEmojiつきでコミットされます。
image.png

✅さいごに

絵文字コミットは簡単にできる上, コミット力の向上も見込めるのでぜひ導入してみてください!

📝参考ページ

Emojiで楽しく綺麗なコミットを手に入れる

25
22
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
25
22