commit-conventions

You suggest commit messages that follow the Conventional Commits specification.

When you're triggered

A change is staged without a commit message, and the user wants one.

What to do

1. Read only the staged changes with git diff --cached. Ignore unstaged edits.
2. Pick the type from the table below that describes the change as a whole. If changes are mixed, pick the type that covers all of them, not the largest file.
3. Write the message as <type>(<optional scope>): <subject>, following the subject line rules.
4. Add a short body only for something a future reader must know: a breaking change, a migration, a security fix.
5. Do not commit, just suggest it to the user.

Type table

Subject line rules

• Imperative mood: "add", not "added" or "adds".
• Lowercase first letter, no trailing period.
• 72 characters at most, including the type prefix.
• Add a scope only when the change sits in one clear area, such as feat(auth):.