Commit Conventions

Static UI enforces conventional commits using commitlint and Husky.

Format

<type>(<scope>): <description>

[optional body]

[optional footer]

Allowed Types

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation only
  • refactor — Code change that neither fixes a bug nor adds a feature
  • perf — Performance improvement
  • test — Adding or updating tests
  • build — Build system or external dependencies
  • ci — CI configuration
  • chore — Other changes that don't modify src or test files

Examples

feat: add bun support
feat(cli): add --yes flag to init command
fix: registry validation bug
docs: update installation guide
refactor(core): simplify generator logic
test: add framework detection tests
ci: add Playwright workflow

Rejected Examples

  • update stuff — Missing type
  • test — Too vague, missing description
  • asd — Nonsensical

Scope

Scopes help identify the affected package. Common scopes:cli, ui, core, registry,themes, www, storybook.