Conventional Commit Helper

Conventional Commit Helper

Overview

Create readable, semantic-release friendly commit messages with a consistent type(scope): subject header plus optional body and footer. Support message drafting, validation, and optional non-interactive git commit execution.

Workflow

1. Inspect changes with git status --short and git diff --cached --name-only.
2. Select type from the allowed set:
   • feat, fix, perf, revert, docs, style, refactor, test, build, ci, chore
3. Infer scope from the affected module, path, or subsystem.
4. Draft subject:
   • imperative/present tense (add, fix, update, remove)
   • lowercase
   • no trailing period
   • prefer <= 50 chars
5. Add body text only when extra context helps review.
6. Add footer lines for issue refs or breaking changes.
7. Validate message using scripts/validate_commit_message.sh.
8. If requested, commit with non-interactive git commands only.

Message Template

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

[optional body]

[optional footer]


## Breaking Change Rules

Use either:
- `type(scope)!: subject`
- `BREAKING CHANGE:` footer

## Resources

- Detailed guidance and examples: `references/commit-conventions.md`
- Message validator: `scripts/validate_commit_message.sh`

## Commands

Validate a message string:

```bash
./scripts/validate_commit_message.sh --message "fix(auth): reject expired refresh token"

Validate a message file:

./scripts/validate_commit_message.sh --file .git/COMMIT_EDITMSG