Gitのコミットコメントを絵文字Prefixにして楽しく開発する

  • 25
    Like
  • 0
    Comment

🔰 はじめに

Git便利ですよね!今回はそんな便利なGitをより楽しく使うTipsです!
この記事はGoodpatchさんのEmojiで楽しく綺麗なコミットを手に入れるを参考にさせていただきました。
ありがとうございます🙇

gitのコミットを眺めていると文字の羅列でばっかりで、ノってないときは苦痛な時も人間あるでしょう😱
そんな時は絵文字Prefixにする事でみためも楽しくなり、コミットメッセージ自体に意味を持たせる事もでき、楽しく開発が出来ると思います。

💁 コミットメッセージテンプレートの作成

gitのコミットのテンプレートの作成はこちらを参考にさせていただきました。

今回は、.gitmessage というファイルを作成して試しに採用するリポジトリのrootディレクトリに配置して使ってみます。1

[commit]
    template = .gitmessage #このパスを任意で変更 ~/.gitmessageなど

今回は該当のリポジトリ内の.git/config の内容を変更しました。これだけで準備は完了です。

🛠 使ってみる

では実際に使ってみましょう!

$ git commit

とすると、下記の様にテンプレートが表示され、それを見ながらコミットメッセージを入力する事ができます。
ステキですね🌟

2016年9月28日 追記

こちら、SourceTreeなどで、コミットコメントに直接絵文字を入力してしまうと、Web、SourceTree上では絵文字が表示されるが、ターミナルでは、絵文字以降がブランクになってしまう現象が発生してしまいました。原因不明。

🚧 TODO

  • [ ] 現在は、ターミナルからでしか動かないので、何らかの形でSourceTreeなどのGUIで動かす事ができれば、デザイナーさんにも使ってもらえますね🙆

2017年4月18日 追記

  • 上記設定をしていればSouceTreeでもコミットコメントのテンプレートとして反映されていました。
    • 1点あるとすればターミナル上編集していれば#はコメントとして扱われていましたが、SourceTreeではコミットコメントして反映されてしまうので、いちいち消すのが面倒くさいです🤔



🔚 最後に

いかがでいたでしょうか?
無味無臭だったコミットメッセージが格段に華やいだと思います。コードレビューは時と場合によってしんどいかったりするものですが、少しでもpositiveになればといいですね。
また、コミットに対する意識が個人個人で変わり、よりよりコミット(ざっくりですいません><)を考えるきっかけとなるかもしれません。

余談ですが、テンプレートを拙い英語に訳してもの(元はこちらnownabe/.commit_template)をgistにアップロードしてみました。よろしければ是非使って見てください😀
どの絵文字にどんな意味を持たせるかは、Productだったり、社内の文化だったり,チームでの議論だったりでかわると思いますので、みんなで話し合うのがいいと思います。ちなみにきっかけとなったAtomのものはこちらです。

それでは、Happy Hacking!!🚀🚀🚀

👍 謝辞


  1. すべてのプロジェクトで使用したり、チーム内でコンセンサスがとれている場合は、ローカルのルートなどに格納すればいいと思います。