.png?table=block&id=a5f679a4-a5d4-4646-9b4a-4edb36ee1831&cache=v2)
Gitmojiとは?
gitmojiとはgit + emojiを合わせて呼ぶ言葉で、emojiを使ってcommit messageを作成するツールだと思えばいいようです。今までテキストだけでコミットメッセージを書いてきましたが、メッセージに絵文字(絵文字)を追加したら、後でコミットメッセージを見る時、もっと読みやすくなります。例えば、コミットメッセージに絵文字を使うと、使用された絵文字だけを見てコミットの目的や意図を簡単に識別できるようになります。
上のコミットログのように単純に文章を並べるより、視覚的な強調ができることを感じることができます。 そして、絵文字アイコンに慣れてくると、文章を読まなくても全体的に何が起こったのかが一目でわかるようになります。例えば、✨形の絵文字は機能追加を意味するキモジですが、上の絵文字だけ読んでも機能追加中心の作業であることがすぐにわかります。
また、gitmojiを使う時はコミットを細分化するのが良いのですが、プロジェクトに機能を追加するためのコミットログを✨絵文字一つで終わらせることもできますが、次のようにもっと細かく
- 💄を使用してレイアウト完成時にコミット1回、
- APIやその他の機能を付けた後、画面が完成したら✨で一回、
- テスト作成後、✅までテスト完了アイコンを作成
まですれば、より明確にコミット単位で考えることができるので、プロジェクト管理に良いです。
ただし、実務でgitmojiを使う際に注意すべき点があります。
それはコミットテーマの約束ですが、gitmojiを使う時、どのemojiがどんな意味を表すかについての約束をしてプロジェクトを進める必要があります。
例えば、二人が同じ形の絵文字を置き、異なる解釈をしてコミットメッセージを残すと混乱が起きるからです。
- Aは🐛：バグ修正
- Bは🐛：不要なコードを削除
なので、gitmojiを使う時は必ずチームメンバーとそのemojiがどのような意味を表すかについて共有して適用する必要があります。 もちろん、いちいち絵文字を決めるのは面倒なので、その絵文字の用途、意味をあらかじめ決めている下記のサイトを参考にすることもできます。
サイトに入ると下のように絵文字の形と名前の説明が一緒に表示されますが、その説明を見て適切な絵文字を使用します。参考までに画像をクリックすると、画像がコピーされ、キーワードをクリックするとキーワードがコピーされます。
アイコン | コード | 説明 | 原文 |
🎨 | :art: | コードの構造/形式の改善 | Improve structure / format of the code. |
⚡️ | :zap: | 性能改善 | Improve performance. |
🔥 | :fire: | コード/ファイルの削除 | Remove code or files. |
🐛 | :bug: | バグ修正 | Fix a bug. |
🚑 | :ambulance: | 緊急修正 | Critical hotfix. |
✨ | :sparkles: | 新機能 | Introduce new features. |
📝 | :memo: | 文書の追加/修正 | Add or update documentation. |
💄 | :lipstick: | UI/スタイルファイルの追加/修正 | Add or update the UI and style files. |
🎉 | :tada: | プロジェクト開始 | Begin a project. |
✅ | :white_check_mark: | テストの追加/修正 | Add or update tests. |
🔒 | :lock: | セキュリティ問題の修正 | Fix security issues. |
🔖 | :bookmark: | リリース/バージョンタグ | Release / Version tags. |
💚 | :green_heart: | CIビルドの修正 | Fix CI Build. |
📌 | :pushpin: | 特定のバージョン依存性固定 | Pin dependencies to specific versions. |
👷 | :construction_worker: | CIビルドシステムの追加/修正 | Add or update CI build system. |
📈 | :chart_with_upwards_trend: | 分析、追跡コードの追加/修正 | Add or update analytics or track code. |
♻️ | :recycle: | コードのリファクタリング | Refactor code. |
➕ | :heavy_plus_sign: | 依存関係の追加 | Add a dependency. |
➖ | :heavy_minus_sign: | 依存性の除去 | Remove a dependency. |
🔧 | :wrench: | 設定ファイルの追加/削除 | Add or update configuration files. |
🔨 | :hammer: | 開発スクリプトの追加/修正 | Add or update development scripts. |
🌐 | :globe_with_meridians: | 国際化・現地化 | Internationalization and localization. |
💩 | :poop: | クソ安いコード | Write bad code that needs to be improved. |
⏪ | :rewind: | 変更内容を元に戻す | Revert changes. |
🔀 | :twisted_rightwards_arrows: | ブランチ合併 | Merge branches. |
📦 | :package: | コンパイルされたファイルの追加/修正 | Add or update compiled files or packages. |
👽 | :alien: | 外部APIの変更による修正 | Update code due to external API changes. |
🚚 | :truck: | リソースの移動、名前変更 | Move or rename resources (e.g.: files paths routes). |
📄 | :page_facing_up: | ライセンスの追加/修正 | Add or update license. |
💡 | :bulb: | コメントの追加/修正 | Add or update comments in source code. |
🍻 | :beers: | 酔っぱらって書いたコード | Write code drunkenly. |
🗃 | :card_file_box: | デーバーベース関連の修正 | Perform database related changes. |
🔊 | :loud_sound: | ログの追加/修正 | Add or update logs. |
🙈 | :see_no_evil: | .gitignore 追加/修正 | Add or update a .gitignore file. |
gitmojiを使ってみよう
Gitでgitmoji(gitmoji)を使うためには別途にソフトウェアをインストールするようにプログラムが必要です。
任意のターミナルで自由に使えるgitmoji-cli方法とVSCodeエディタで簡単に使えるgitmoji拡張パックを紹介します。
gitmoji-cli
ターミナルでソースをコミットする時
gitmoji-cliを使うと絵文字を一緒にコミット内容に簡単に含めることができます。まず、gitmoji-cliをインストールしましょう。
> npm i -g gitmoji-cli # or> brew install gitmojiCopy
Tipgitmoji-cliはnpmパッケージが必要なので、その前にnode.jsを先にインストールする必要があります。インストール後、
gitmoji --helpをターミナルに入力するとヘルプが確認できます。
gitmoji ログの使い方
簡単に
gitmoji -c コマンドでgitmojiコミットを作成することができます。まず、git addコマンドで変更をステージングして、git commit -mの代わりにgitmoji -cでコミットメッセージを作成します。
コマンドを実行するとemojiリストが出てきて、矢印を使って上下に移動しながら選択したり、好きなkeywordを書いてemojiを選ぶこともできます。
emojiを選択した後はcommit titleとcommit messageを書いてEnterを押してcommitを完了します。その後remoteにpushをしたらgithubでgitmojiで作成されたcommit logを確認することができます。
VSCode - Gitmoji拡張機能
もしターミナルで使うのが面倒なら、VSCodeエディタで簡単なGUI環境で簡単に使うことができます。
댓글