seosd97 avatar

commit-message

Generate semantic commit messages. Use when committing changes or writing git commit messages.

by seosd97|Open Source

Commit Message (Semantic)

Format

<type>(<scope>): <subject>

<body>

<footer>

Types

TypeDescription
featNew feature
fixBug fix
docsDocumentation changes
styleCode style (formatting, semicolons, etc.)
refactorCode refactoring (no feature/fix)
perfPerformance improvement
testAdding/updating tests
buildBuild system or dependencies
ciCI/CD configuration
choreMaintenance tasks
revertRevert previous commit

Scope (optional)

Component or area affected:

  • auth, api, ui, router, config, etc.

Rules

  1. Subject: imperative mood, lowercase, no period, max 50 chars
  2. Body: explain what and why (not how)
  3. Footer: breaking changes, issue references

Examples

feat(auth): add login with google

fix(api): handle null response from user endpoint

refactor(components): extract header into separate component

docs: update README with setup instructions

chore: update dependencies

feat(router)!: change route structure

BREAKING CHANGE: routes now use folder-based structure

Breaking Changes

Use ! after type/scope or add BREAKING CHANGE: in footer:

feat(api)!: change response format

BREAKING CHANGE: API now returns { data, meta } instead of raw data