navikt Conventional Commit Skill
Generate commit messages following the Conventional Commits specification, adapted for Nav projects.
Format
<type>(<scope>): <description>
[optional body]
[optional footer]
Types
| Type | Usage |
|---|---|
feat |
New functionality |
fix |
Bug fix |
docs |
Documentation-only changes |
style |
Formatting, semicolons, etc. (no code change) |
refactor |
Code that neither fixes a bug nor adds a feature |
perf |
Performance changes |
test |
Adding or fixing tests |
build |
Build system or dependency changes |
ci |
CI configuration changes |
chore |
Other changes that don't affect code |
Nav-relevant scopes
feat(vedtak): add support for complaint decisions
fix(auth): fix token validation for TokenX
docs(api): update OpenAPI spec for the vedtak endpoint
refactor(repository): use CTE for better readability
test(controller): add integration test with MockOAuth2Server
build(deps): upgrade Spring Boot to 3.4.1
ci(deploy): add prod deploy step
perf(db): add index on bruker_id
chore(nais): update resource limits
Breaking Changes
feat(api)!: change response format for the vedtak endpoint
BREAKING CHANGE: The `vedtakDato` field has been changed to `opprettetDato`.
Consumers must update their parsing.
Rules
- First line: max 72 characters
- Use imperative form: "add", not "added" or "adds"
- Don't end with a period
- Use Norwegian or English consistently within the project
- Reference Jira/GitHub issue in footer:
Closes #123orRefs NAV-1234
Examples
# Simple feature
git commit -m "feat(søknad): add validation of national identity number"
# Bugfix with reference
git commit -m "fix(auth): handle expired refresh token
The refresh token was not renewed upon expiration, which caused
users to be logged out without warning.
Fixes #456"
# Dependency update
git commit -m "build(deps): upgrade postgresql driver to 42.7.4"
# Breaking change
git commit -m "feat(api)!: remove deprecated /api/v1/vedtak endpoint
BREAKING CHANGE: /api/v1/vedtak has been removed. Use /api/v2/vedtak."
Analyzing Staged Changes
To generate a commit message, analyze staged changes:
git diff --cached --stat # Overview of changed files
git diff --cached # Detailed diff
Based on the diff:
- Identify type (feat/fix/refactor/etc.)
- Identify scope (which module/domain)
- Write short, precise description
- Add body if the change needs explanation
- Add
BREAKING CHANGEfooter if the API changes