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