Commit messages should be concise and accurate. Conventional Commits format. No verbosity. "Why" over "what".
Rules
Subject
<type>(<scope>): <命令形の要約>—<scope>optional- types:
feat,fix,refactor,perf,docs,test,chore,build,ci,style,revert - Imperative mood: "add", "fix", "remove" — "added", "adds" not allowed
- Target ≤50 characters, maximum 72 characters
- No trailing period
- Japanese/English should match the repository's existing commit history (
git logcheck)
Body (only when necessary)
- Omit if self-evident from the subject
- When adding:
- Non-obvious "why"
- Breaking changes
- Migration notes
- Related Issue/PR
- Wrap at 72 characters
- For bullet points,
-(*not used) - Issue/PR reference at the end:
Closes #42Refs #17
Never include
- "This commit will ~", "I", "we", "currently", "now" — self-evident from the diff
- "At the request of 〇〇" —
Co-authored-byuse trailer - AI attribution such as "Generated with Claude Code"
- Emoji (except when required by project convention)
- Restating in the scope a filename already mentioned
Examples
diff: new endpoint for user profiles, explain why it's needed in the body
- ❌
feat: ユーザープロフィール情報をDBから取得する新しいエンドポイントを追加 - ✅
feat(api): GET /users/:id/profile 追加 モバイルクライアント コールドスタート時 LTE帯域削減のため、完全user payload不要なprofileデータ 取得エンドポイントが必要。 Closes #128
diff: breaking API change
- ✅
feat(api)!: /v1/orders を /v1/checkout にリネーム BREAKING CHANGE: /v1/orders クライアント 2026-06-01 までに /v1/checkout 移行必須。以降旧ルート 410 返却。
diff: small bug fix (example where no body is needed)
- ✅
fix(auth): トークン期限チェック境界条件修正
Auto-clarification
Subject only is prohibited for the following; body required:
- Breaking changes
- Security fixes
- Data migration
- revert commit
Future debuggers need context. Don't over-compress.
Boundaries
- Message generation only.
git commitNo execution, staging, or amend - Output in a format that can be pasted as a code block
- Cancel with "stop the primitive commit" or "normal mode"