💬

gitmojiの使い方

commits3 min read

はじめに

gitmojiの導入方法とその使い方の流れについてまとめました:-)

gitmojiとは

簡単に言うと、gitのコミットメッセージに絵文字をつけることが出来るようになり、それぞれのコミットの意味を視覚的にわかりやすくすることができるものです(gitmoji


画像は一例です

gitmoji-cliをインストールする

gitmoji-cliというパッケージを用いると、gitmoji -cというコマンドを打つだけで、絵文字の検索からメッセージの入力、コミットまでをスムーズに行うことができます。

以下のコマンドでgitmoji-cliをインストールします。

npm i -g gitmoji-cli

gitmojiの使い方(概略)

おおよその流れは以下のようになります。

  1. コードの変更をする
  2. git add .して変更をステージに上げる
  3. gitmoji -cコマンドを打ち、コミットに合った絵文字を選ぶ
  4. コミットタイトルを入力する(これがgit commit -m "コミットメッセージ"のところに相当する)
  5. コミットメッセージを入力する(このコミットの詳細文を打てるようなところ)
  6. git pushしてコミットを反映させる

gitmojiの使い方(詳細)

1. コードを変更する

コーディングしましょう。

2. git add .して変更をステージに上げる

git add .コマンドで、コードの変更をステージングします。
git add 変更したファイル名でも勿論大丈夫です。お好きな方でどうぞ。

3. gitmoji -cコマンドを打ち、コミットに合った絵文字を選ぶ

コミットする時に通常のgit commit -m "コミットメッセージ"ではなく、gitmoji -cコマンドを打つと、以下のような表示が出るので今回の変更に合った絵文字を選びます。

4. コミットタイトルを入力する(ここが通常のコミットメッセージの部分に相当)

この4番と5番のところはとてもややこしいので、下の5番と合わせて画像つきで説明します。

5. コミットメッセージを入力する(コミットの詳細文を打てるようなところ)

? Enter the commit title について

名前がややこしいので最初少し戸惑ったのですが、絵文字を選択した次に出てくる? Enter the commit titleというところで入力するものが、通常のgit commit -m "コミットメッセージ"でいうところのコミットメッセージの部分に相当します(下の画像も参照してみてください)

? Enter the commit message について

そして4番のコミットタイトルの入力後に出てくる? Enter the commit messageというところで入力するものが、上で指定したコミットの詳細説明のようなものになります。



文章で表現するのはとてもややこしいですが、下の画像を見れば比較的すんなり理解できるのではないかと思います。

「バグを修正」というコミットメッセージの横にある3点リーダ(...)の部分をクリックすると、? Enter the commit messageの部分で入力した文章が出てきます。

名前がややこしい…!

6. git pushしてコミットを反映させる

さて、ここまで来たらあとはもうgit pushをして完了です。

おわりに

gitmoji使いたいなあとは思ってはいつつも、中々手が出ずずっと後回しにしてしまっていたのでこれを機に使い方を学ぶことが出来てよかったです!

これでまたGitを使うのが楽しくなりそうですね!

参考

コミットメッセージ運用メモ(個人用)

以下は完全に個人用なのであまり気にしないでください。笑

  • feat: 〜  新機能の追加・実装
    • 新機能っぽいものの原型が出来たときにこれでコミットする
  • 📝 docs: 〜 ドキュメントのみの変更
    • 処理に直接関係のないテキストやコメントアウト、READMEなどの追加・更新
  • 🎨 style: 〜 UIやデザイン関連の変更やコード上のセミコロン云々など
  • ♻️ refac: 〜 仕様や機能に影響がないコードの改善(リファクタリング)
  • 🩹 fix: 〜 軽微な問題の修正
    • ちょっとしたエラーの解決などはこれでコミット
    • typoの修正もここ
  • 🐛 bug: 〜 バグの修正
    • 「バグ」は正式運用後に出てきた問題に対してかな
  • 🚧 work: 〜 コーディングや上記に含まれない作業など
    • 新機能実装までのコード書きなど。もくもくとコーディングをしている(コミットとしてはコレが一番多くなる)
    • ライブラリの追加や更新、削除等もここ
    • .gitignoreファイルの更新等もここ

参考: 僕が考える最強のコミットメッセージの書き方
参考:コミットに絵文字を追加するルールを設けてみた 🎉