search

aiueo49 / StudyTracer

https://studytracer-frontend.vercel.app
0 stars 0 forks source link

[開発の作法]コミットの粒度とコミットメッセージのルールを設定 #1

Open aiueo49 opened 6 months ago

aiueo49 commented 6 months ago

コミットしたりしなかったり、 コミットの粒度が大きすぎたり小さすぎたり、 ばらつきを抑えて後から見返したときに、わかりやすいようにルールを決める。

# ==================== Emojis ====================
# 🎉  :tada:     初めてのコミット（Initial Commit）
# 🔖  :bookmark: バージョンタグ（Version Tag）
# ✨  :sparkles: 新機能（New Feature）
# 🐛  :bug:      バグ修正（Bagfix）
# ♻️   :recycle:    リファクタリング(Refactoring)
# 📚  :books:    ドキュメント（Documentation）
# 🎨  :art:      デザインUI/UX(Accessibility)
# 🐎  :horse:    パフォーマンス（Performance）
# 🔧  :wrench:   ツール（Tooling）
# 🚨  :rotating_light:  テスト（Tests）
# 💩  :hankey:          非推奨追加（Deprecation）
# 🗑  :wastebasket:      削除（Removal）
# 🚧  :construction:    WIP(Work In Progress)
# ================================================
aiueo49 commented 6 months ago

GPTくんにEmojiの使い分けを教えてもらいましたので参考に！

各コミットメッセージの絵文字は、そのコミットが行った変更内容を示すためのものです。以下に、それぞれの絵文字の意味と使い方を説明します。

  1. 🎉 :tada: 初めてのコミット（Initial Commit）: 新しいプロジェクトを初めてリポジトリに追加したときや、新しい機能を初めて追加したときに使用します。

  2. 🔖 :bookmark: バージョンタグ（Version Tag）: 特定のバージョンに対してリリースされたコードにタグを付けるときに使用します。一般的に、安定版のリリースポイントをマークするために使います。

  3. ✨ :sparkles: 新機能（New Feature）: 新しい機能や機能の追加、改善など、ユーザーや開発者に新しい価値を提供する変更に使用します。

  4. 🐛 :bug: バグ修正（Bagfix）: バグを修正した際に使用します。既存の機能が正しく動作しない場合や、予期せぬ挙動がある場合に使用します。

  5. ♻️ :recycle: リファクタリング(Refactoring): コードのリファクタリングや改善、最適化を行った際に使用します。機能の変更は行わず、コードの構造や可読性、保守性を向上させる変更に使用します。

  6. 📚 :books: ドキュメント（Documentation）: ドキュメントの追加や更新を行った際に使用します。コードの説明やAPIドキュメント、チュートリアルなどの追加や更新に使用します。

  7. 🎨 :art: デザインUI/UX(Accessibility): ユーザーインターフェース(UI)やユーザーエクスペリエンス(UX)の改善、デザインの変更を行った際に使用します。

  8. 🐎 :horse: パフォーマンス（Performance）: コードやシステムのパフォーマンスの改善を行った際に使用します。処理速度の向上やリソースの効率化などが含まれます。

  9. 🔧 :wrench: ツール（Tooling）: 開発に使用するツールやライブラリの追加、更新、設定の変更を行った際に使用します。

  10. 🚨 :rotating_light: テスト（Tests）: テストコードの追加、修正、テストの実行結果に関する変更を行った際に使用します。

  11. 💩 :hankey: 非推奨追加（Deprecation）: 非推奨の機能やAPIの追加、更新、削除を行った際に使用します。古い機能の代替案を提供する場合にも使用します。

  12. 🗑️ :wastebasket: 削除（Removal）: 不要なコードやファイル、機能の削除を行った際に使用します。

  13. 🚧 :construction: WIP(Work In Progress): 作業中であることを示すために使用します。コードの一部を一時的にコミットする際などに使用します。

これらの絵文字を使って、コミットメッセージを見やすく、わかりやすくすることができます。

aiueo49 commented 6 months ago

参考

適切な履歴の作り方