UXDL Docs

Commit Conventions

Conventional commits, message format, and changelog generation.

We use Conventional Commits for all repositories.

Format

plaintext
<type>(<scope>): <description>
 
[optional body]
 
[optional footer]

Types

TypeWhen to use
featNew feature or capability
fixBug fix
docsDocumentation only
choreTooling, deps, config
refactorCode change without feature/fix
testAdding or updating tests
perfPerformance improvement

Examples

plaintext
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.0

Rules

  • Use present tense, lowercase, no period at end
  • Scope is optional but recommended (auth, api, frontend)
  • Breaking changes: add ! after type or BREAKING 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.