Commit Conventions
Conventional commits, message format, and changelog generation.
We use Conventional Commits for all repositories.
Format
<type>(<scope>): <description>
[optional body]
[optional footer]Types
| Type | When to use |
|---|---|
feat | New feature or capability |
fix | Bug fix |
docs | Documentation only |
chore | Tooling, deps, config |
refactor | Code change without feature/fix |
test | Adding or updating tests |
perf | Performance improvement |
Examples
feat(auth): add Cognito token refresh middleware
fix(api): resolve race condition in project listing
docs(frontend): update Angular deployment guide
chore(deps): upgrade Next.js to 16.0Rules
- Use present tense, lowercase, no period at end
- Scope is optional but recommended (
auth,api,frontend) - Breaking changes: add
!after type orBREAKING CHANGE:in footer - Keep subject under 72 characters
Changelog
Releases auto-generate changelogs from commit history. Only feat and fix appear in user-facing release notes.