Conventional Commits
The standardized language for project history. Mastering this is key to unlocking SemVer AI's full potential.
The Base Format
<type>(<scope>): <short summary>
Example: feat(auth): add JWT authentication
Mandatory Types
feat
New feature
fix
Bug fix
refactor
Code change
chore
Build/Config
docs
Documentation
test
Tests
perf
Performance
style
Formatting
Breaking Changes
Major versions are now triggered by including BREAKING CHANGE: or BREAKING-CHANGE: anywhere in the commit message (subject or body). The requirement for the ! prefix has been removed to avoid shell expansion issues.
feat(api): upgrade to v2 endpoint This update changes the response structure for user profiles. BREAKING-CHANGE: the /api/v1/user route is now deprecated.
Correct vs Incorrect
feat(auth): add JWT authenticationfeat: added user auth systemGolden Rule: Atomic Commits
One commit = One intention. This allows the AI to better understand the nuances of each change and generate more accurate, technical, and useful release notes for your team.
