✏️
【絵文字でわかりやすく】僕のコミットルール
自分が開発チームのリーダーを担ったり、趣味で開発したりする際に使用するコミットルールをまとめました。
コミットルール：シンボルベースコミット
Angular のコミットルールとgitmojiを参考にしたコミットルールです。僕は【シンボルベースコミット】と名付けています。
👇のような感じで使っています。
コミットメッセージ
コミットメッセージは [シンボル][要約]_[issueNumber]の通りに記載します。
【例】 🐛 削除フラグが更新されない不具合の修正_#123456
シンボルベースコミットのメリット・デメリット
メリット
- コミット単位が明確になり、属人性のあるコミットとなりにくい
- どんなコミットだったのか一目でわかる
- なんかかっこいい
デメリット
- シンボルの意味を頭に入れるまで、ぱっと見で理解しにくい（🐛 がバグ改修とか。。）
シンボル一覧
| シンボル | 意味 |
|---|---|
| ✨ | 新機能追加 |
| 🐛 | バグ修正 |
| 📝 | ドキュメントのみの変更 |
| 🎨 | コードの動作に影響しない見た目だけの変更 |
| ♻️ | リファクタリング |
| 🚚 | 機能やUIが変更しないファイル・ディレクトリの移動 |
| ⚡️ | パフォーマンス改善 |
| ✅ | 成功するテスト追加や修正 |
| 🧪 | 失敗するテスト追加や修正 |
| 🔧 | 補助ツールやライブラリの変更 |
| 🎉 | 初めてのコミット |
| 🍱 | assets の追加・アップデート |
| 🙈 | .gitignore のアップデート |
| ✏️ | タイポ修正 |
| 🚧 | WIP（Work In Progress） |
最後に
簡単な紹介になりますが、以上となります。
コミットルールは、開発全員がわかりやすく、保守性高く設定できるのが最高なので、どんどん使いやすさを追求していけたらよいなと思っています。
最後までご覧いただきありがとうございました！🙏
Discussion