Gitコミットメッセージの作成ガイドライン。コミット作成時、`git commit`実行時、またはユーザーがコミットメッセージの書き方について質問した際に使用する。日本語でのコミットメッセージ作成ルールを提供。
name: commit-message-rules
description: Gitコミットメッセージの作成ガイドライン。コミット作成時、git commit実行時、またはユーザーがコミットメッセージの書き方について質問した際に使用する。日本語でのコミットメッセージ作成ルールを提供。
コミットメッセージルール
基本ルール
- コミットメッセージは日本語で記述する
- 1行目は変更内容の要約（50文字以内を推奨）
- 必要に応じて空行を挟んで詳細を記述
フォーマット
<種別>: <変更内容の要約>
<詳細な説明（任意）>
種別（プレフィックス）
| プレフィックス | 用途 |
|---|
feat | 新機能の追加 |
fix | バグ修正 |
docs | ドキュメントのみの変更 |
style | コードの意味に影響しない変更（空白、フォーマット等） |
refactor | バグ修正や機能追加を伴わないコード変更 |
perf | パフォーマンス改善 |
test | テストの追加・修正 |
chore | ビルドプロセスやツールの変更 |
良い例
feat: ユーザー認証機能を追加
JWTトークンを使用した認証を実装。
ログイン/ログアウトAPIエンドポイントを追加。
fix: パスワードリセット時のエラーを修正
refactor: データベース接続処理を共通化
悪い例
update - 何を更新したか不明fix bug - どのバグか不明WIP - 作業中のコミットは避ける- 英語のメッセージ - 日本語で記述すること
注意事項
- コミット前に
git diff で変更内容を確認
- 1つのコミットには1つの論理的な変更のみ含める
- 「なぜ」変更したかを重視して記述