このツールについて
Gitmojiは、コミットメッセージの先頭に意図を一目で示す絵文字を付けるコミュニティの慣習であり、Git自体の機能ではありません。✨は新機能、🐛はバグ修正、📝はドキュメント、♻️はリファクタリングを表し、他にもCIの変更やアクセシビリティ改善などをカバーする約70種類の絵文字があります。gitmoji付きのメッセージが並んだ`git log`をざっと見るだけで、各行を読まなくてもどんな作業が行われたか把握でき、チームによってはこの絵文字をchangelog生成やsemverのバージョン更新に直接結び付けています。
このチートシートは、公式gitmojiデータセットのすべての絵文字を`:code:`ショートコード・説明・大まかなカテゴリー付きで一覧表示し、検索やカテゴリー絞り込みで目的のものをすばやく見つけられます。各行には3つのコピーボタンがあります:絵文字そのもの、貼り付けにすぐ使える末尾スペース付きの`:code:`ショートコード、またはターミナルにそのまま貼り付けて続きを入力できる完全な`git commit -m ":code: "`行です。すべてブラウザ内でローカルに動作し、入力した内容はどこにも送信されません。
これはcarloscuesta/gitmojiのオープンソースgitmojiデータ(MITライセンス)を基にした独立したリファレンスです。オリジナルプロジェクトとの提携や公認を受けたものではありません——正式な一覧や公式ツール(CLIやIDE拡張を含む)についてはgitmoji.devをご覧ください。
よくある質問
gitmojiとは何ですか?
Gitmojiは、Gitのコミットメッセージの先頭に絵文字を付けて、そのコミットがどんな種類の変更かを一目で示すコミュニティの慣習です——新機能には✨、バグ修正には🐛、ドキュメントには📝、というように。Git自体の機能や必須の規格ではなく、コミット履歴をざっと見やすくするために一部のチームやオープンソースプロジェクトが採用している命名の慣習にすぎません。ワークフローによっては、changelogの生成や自動的なsemverのバージョン更新に使われることもあります。
コミットメッセージでgitmojiをどう使えばいいですか?
変更内容に合ったgitmojiを見つけ、その絵文字(または、GitHubのコメントのようにショートコードを表示できるGitホストやターミナルを使っているなら`:code:`ショートコード)をコミットメッセージの先頭に置き、その後に簡潔な説明を続けます——例えば`✨ Add dark mode toggle`や`:bug: Fix off-by-one error in pagination`のように。このツールの「Commit」コピーボタンは完全な`git commit -m ":code: "`コマンドを作成してくれるので、ターミナルにそのまま貼り付けて残りのメッセージを入力するだけで済みます。
これは公式のgitmojiツールですか?
いいえ——これはCarlos Cuestaがgithub.com/carloscuesta/gitmojiで公開しているオープンソースのgitmojiデータ(MITライセンス)を基にした独立したリファレンスです。そのプロジェクトと提携、公認、公式な関係は一切ありません。既存のgitmoji一覧の検索とコピーを速くすることだけを目的としています。正式な一覧、公式CLI、IDE連携についてはgitmoji.devをご覧ください。
一部のgitmojiの横にある「major/minor/patch」という小さなラベルは何を意味しますか?
これは、プロジェクトがsemverに従いコミット履歴から自動的にバージョンを上げている場合に、その種類のコミットが意味するとgitmojiプロジェクトが提案しているセマンティックバージョニング(semver)の上げ幅です——例えば💥(boom)は破壊的変更を示すためmajorを提案し、✨(sparkles)は何も壊さずに機能を追加するためminorを提案します。📝(memo、ドキュメント)のような多くのgitmojiにはバージョニングの意味合いが全くなく、空欄のままです。これは強制されるルールではなく、あくまで役立つヒントとして捉えてください——多くのチームはバージョニングの自動化を一切行わず、読みやすさのためだけにgitmojiを使っています。