Skip to content

commitlint.md

Latest commit

 

History

History
92 lines (67 loc) · 1.97 KB

commitlint.md

File metadata and controls

92 lines (67 loc) · 1.97 KB
title Commitlint
type guide
status published
summary Enforce conventional commit messages
related
husky
locale en-US

Commitlint

Validates commit messages against the conventional format via Git hooks. Rules are centralized in @regardio/dev.

Configuration

At the workspace root, create .commitlintrc.json:

{
  "extends": ["@regardio/dev/commitlint"]
}

Or use a JavaScript config:

// commitlint.config.cjs
module.exports = require('@regardio/dev/commitlint');

Commit Format

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

[optional body]

[optional footer]

Types

Type Description
feat New feature
fix Bug fix
docs Documentation only
style Formatting, no code change
refactor Code change that neither fixes nor adds
perf Performance improvement
test Adding or updating tests
build Build system or dependencies
ci CI configuration
chore Other changes (tooling, etc.)
revert Revert a previous commit

Examples

feat: add user authentication
fix: resolve login redirect loop
docs: update API documentation
refactor: simplify payment processing
test: add unit tests for date utilities
chore: update dependencies
feat(auth): implement OAuth2 flow
fix(api): handle null response gracefully

Rules

The preset enforces:

  • Header max length: 100 characters
  • Body leading blank: Blank line before body
  • Footer leading blank: Blank line before footer
  • Type enum: Must be one of the allowed types

Git Hooks

Commitlint runs automatically via Husky on commit. See Husky for setup.

Related documents:

Resources