Git Commit ガイドライン
概要
このプロジェクトではConventional Commits形式に基づいた
コミットメッセージを使用します。
commitlint.config.jsの設定に従い、一貫性のあるコミット履歴を維持します。
コミットメッセージの形式
commitlint.config.jsの設定では、コミットタイプ（type）のみが必須です。
形式
<type>- type: コミットの種類（必須）- 次の13種類から選択
コミットタイプ
commitlint.config.jsで許可されている次の13種類のタイプを使用します。
feat - 新機能
新機能の追加に使用します。
# ✅ Goodfeatfix - バグ修正
バグの修正に使用します。
# ✅ Goodfixdocs - ドキュメントのみの変更
ドキュメントの追加や修正に使用します。コードの変更を伴わない場合に使用します。
# ✅ Gooddocsstyle - コードの動作に影響しない変更
フォーマット、セミコロンの追加・削除、インデントの調整など、コードの動作に影響しない変更に使用します。
# ✅ Goodstylerefactor - コードのリファクタリング
機能追加やバグ修正を伴わないコードの改善に使用します。
# ✅ Goodrefactorperf - パフォーマンス改善
パフォーマンスの改善に使用します。
# ✅ Goodperftest - テストの追加や修正
テストコードの追加や修正に使用します。
# ✅ Goodtestbuild - ビルドシステムの変更
ビルドツールや依存関係の変更に使用します。
# ✅ Goodbuildci - CI設定の変更
CI/CDパイプラインの設定変更に使用します。
# ✅ Goodcichore - その他の変更
上記のいずれにも該当しない変更に使用します。設定ファイルの変更、ツールの設定変更など。
# ✅ Goodchorerevert - 以前のコミットの取り消し
以前のコミットを取り消す場合に使用します。
# ✅ Goodrevertimprovement - 改善
既存機能の改善に使用します。新機能追加（feat）でもバグ修正（fix）でもない、機能の改善に使用します。
# ✅ Goodimprovementsecurity - セキュリティ関連の修正
セキュリティ脆弱性の修正やセキュリティ強化に使用します。
# ✅ Goodsecurityコミットメッセージの書き方
重要なポイント
commitlint.config.jsの設定では、コミットタイプ（type）のみが必須です。
- type: 必須。次の13種類から選択
必須事項
次の点は必須です：
# 有効なコミットメッセージfeatfixdocsAI向けの特別なガイドライン
変更内容の正確な反映（必須）
- 変更内容を確認:
git diffやgit statusで変更内容を確認してからコミット（必須） - 適切なタイプの選択: 変更内容にもっとも適したタイプを選択（必須）
複数の変更がある場合
- 分割は必須: 1つのコミットに1つの変更を必須とする
- タイプが異なる場合は分割: 異なるタイプの変更は必ず分割する（必須）
# ✅ Good: 異なるタイプは分割feattest
# ❌ Bad: 異なるタイプを1つにまとめる（不可能）タイプの選択ガイド（必須）
変更内容に応じて適切なタイプを選択してください（必須）。
| 変更内容 | タイプ |
|---|---|
| 新機能の追加 | feat |
| バグの修正 | fix |
| ドキュメントの変更 | docs |
| フォーマットやスタイルの変更 | style |
| コードのリファクタリング | refactor |
| パフォーマンスの改善 | perf |
| テストの追加・修正 | test |
| ビルドツールの変更 | build |
| CI設定の変更 | ci |
| その他の変更 | chore |
| コミットの取り消し | revert |
| 既存機能の改善 | improvement |
| セキュリティ関連の修正 | security |
コミット前の確認事項
- 変更内容の確認:
git statusとgit diffで変更内容を確認（必須） - タイプの選択: 変更内容にもっとも適したタイプを選択（必須）
- テストの実行: 変更が既存のテストを壊していないか確認（必須）