スポーティーズ
可読性の高いコミット履歴を維持し、変更内容の追跡やリリースノードの自動作成を容易にするためコミットメッセージに特定の規約を設ける。
コミットメッセージは以下のフォーマットで記述してください。
<type>(<scope>): <subject>
<BLANK_LINE>
<body>
<BLANK_LINE>
<footer>
ヘッダーは必須です。type、scope、subjectの順で記述します。
<type>
コミットの種類を示す識別子です。以下のいずれかを使用してください。
- feat: ✨ 新機能の追加
- fix: 🐛 バグの修正
- docs: 📝 ドキュメントの更新
- style: 💎 コードの意味に影響しない変更(スペース、フォーマット、セミコロンなど)
- ref: 🔨 バグ修正や機能追加ではないコードの改善
- perf: 🚀 パフォーマンスの改善
- test: ✅ テストコードの追加または修正
- chore: 📦 パッケージ管理系の変更（npmなど）（例：依存関係の更新など）
- revert: 🔙 コミットを元に戻す
- build: ⚙️ ビルド系の変更（例：webpackなど）
- release: 📦 リリース（例：npmなど）
- ci: 📦 CI系の変更（例：github actionsなど）
- init: 📦 初期化
<scope> (任意)
コミットが影響を与える範囲を示します。このプロジェクトでは、以下のようなスコープが考えられます。
admin-app: 管理者用アプリに関する変更student-app: 学生用アプリに関する変更backend: バックエンド(API)に関する変更db: データベーススキーマやマイグレーションに関する変更
<subject>
変更内容を要約した短い記述です。誰が見ても何を変更したかわかるように記述しましょう。
変更の同期や、これまでの実装との違いなど、より詳細な説明を記述します。subjectだけでは説明が不十分な場合に追加してください。
フッターには、破壊的変更に関する記述や、関連するIssue番号を記載します。
破壊的変更
互換性のない変更を行った場合に記述します。
Issue番号
コミットが特定のIssueを解決する場合に記載します。キーワード(close,fixes)を使用すると、GitHub上で自動的にIssueがクローズされます。