smart-commit

Conventional commit messages are generated by analyzing Git diffs to identify logical units of change, selecting a commit type and scope, and crafting an imperative subject under 72 characters with a structured body explaining the rationale.

Diff analysis examines unstaged and staged changes to group related file modifications into logical units. This staging recommendation ensures that each commit represents a single purpose, keeping your project history readable and avoiding noisy multi-purpose commits.

You can include an optional Co-Authored-By trailer in your conventional commits. The generation process outputs a ready-to-run git commit command that appends the trailer for proper attribution while maintaining the conventional commit format.

Conventional commit format strictly enforces subject length under 72 characters and requires imperative mood. This applies across developer workflows for features, fixes, refactors, tests, docs, styles, and chores to ensure traceability and improve release notes.

Structuring a review-ready commit involves analyzing diffs, staging logical file groups together, and applying conventional commit format with a clear type, scope, and subject. This ensures consistent messages and proper scoping for better traceability.

Automated conventional commit generation should be avoided when changes span multiple unrelated purposes that cannot be logically staged together. The tool targets single, well-structured commits, so heavily mixed modifications require manual staging separation first.