Conventional Commits Examples

cd commitlint

# Install commitlint and husky
npm install

# Activate husky hooks (runs automatically on npm install via "prepare" script)
npx husky init
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg

# Test a valid message
echo "feat(auth): add OIDC login support" | npx commitlint

# Test an invalid message (missing type)
echo "updated auth service" | npx commitlint
# → ✖ subject-empty: subject may not be empty
# → ✖ type-empty: type may not be empty

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

[optional body]

[optional footers]

# ✅ Valid
git commit -m "feat(orders): add idempotency key validation"
git commit -m "fix(auth): reject expired tokens before redirect"
git commit -m "chore(deps): bump axios to 1.7.0"

# ✅ Breaking change
git commit -m "feat(api)!: require Authorization header on all endpoints

BREAKING CHANGE: All endpoints now require a Bearer token. Update clients to v2.x."

# ❌ Invalid — commitlint will reject these
git commit -m "updated stuff"
git commit -m "Fix bug"          # uppercase
git commit -m "feat: add thing." # trailing period

"scope-enum": [2, "always", [
  "api", "auth", "billing", "ci", "config",
  "db", "deps", "docs", "helm", "infra",
  "orders", "terraform", "ui",
]],

# .github/workflows/pr-title.yml
name: Lint PR title
on:
  pull_request:
    types: [opened, edited, synchronize]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@v5.5.3
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}