deanmoses avatar

commit

Generates commit messages and creates commits. Use when writing commit messages, committing changes,

by deanmoses|Open Source

Commit Messages

Use Conventional Commits format.

Format

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

[optional body]

Types

  • feat: User-facing features or behavior changes (must change production code)
  • fix: Bug fixes (must change production code)
  • docs: Documentation only
  • style: Code style/formatting (no logic changes)
  • refactor: Code restructuring without behavior change
  • test: Adding or updating tests
  • chore: CI/CD, tooling, dependency bumps, configs (no production code)

Scopes

Optional. Use when it adds clarity. Examples: cloudfront, s3, ci.

Breaking Changes

Use ! suffix: feat!: remove deprecated resource

Examples

feat(cloudfront): add immutable cache headers
fix: correct CloudFront Function ARN attribute
chore: add husky pre-commit hooks
docs: update architecture documentation

Instructions

  1. Run git diff --staged to see staged changes
  2. Analyze the changes and determine the appropriate type
  3. Write a concise description (under 72 characters)
  4. Add body only if the "why" isn't obvious from the description