CONTRIBUTING.mdでのGitmojiコミット規約

コミットメッセージにGitmojiを使用する

Gitmojiは、コミットタイププレフィックスとして絵文字を使用します。Conventional Commitsほど正式ではありませんが、gitログを視覚的にスキャンしやすくし、コントリビューターにとって楽しいものになります。

フォーマット

:emoji: 変更の説明

必須のGitmoji

絵文字	ショートコード	意味
:sparkles:	:sparkles:	新機能
:bug:	:bug:	バグ修正
:memo:	:memo:	ドキュメント
:art:	:art:	コードの構造/フォーマットの改善
:zap:	:zap:	パフォーマンス改善
:fire:	:fire:	コードまたはファイルの削除
:white_check_mark:	:white_check_mark:	テストの追加・更新
:lock:	:lock:	セキュリティ問題の修正
:wrench:	:wrench:	設定の追加・更新
:arrow_up:	:arrow_up:	依存関係のアップグレード
:recycle:	:recycle:	コードのリファクタリング
:globe_with_meridians:	:globe_with_meridians:	国際化

実際の例

:sparkles: 設定ページにダークモードトグルを追加
:bug: ページネーションコンポーネントの無限ループを修正
:memo: API認証ドキュメントを追加
:zap: スクロール時に画像を遅延読み込み
:white_check_mark: ユーザーサービスのユニットテストを追加

gitmoji-cliの使用

npm install -g gitmoji-cli
gitmoji -c  # 絵文字ピッカー付きインタラクティブコミット

メリットとデメリット

メリット: 視覚的なgitログ、スキャンしやすい、楽しい、Conventional Commitsより障壁が低い。

デメリット: 絵文字はプラットフォームによって異なるレンダリング、changelogジェネレーターがネイティブサポートしていない、ターミナルでgrepしにくい。

Gitmojiを選ぶ場面

Gitmojiは、よりカジュアルな雰囲気のプロジェクト、小規模チーム、自動セマンティックバージョニングの必要がない場合にうまく機能します。自動changelogが必要な場合は、代わりにConventional Commitsを検討してください。