What problem does it solve?
Writing clear, consistent git commit messages is essential for future readers to understand why changes were made and how they relate to the project history. This guide teaches a disciplined approach to formatting subjects, composing bodies, and applying trailers to attribute authorship.
Core Features & Use Cases
- Subject line guidance: enforce the conventional format (type(scope): short description) with a clear, concise description.
- Body guidance: explain the why, scope, and technical details when appropriate to provide context beyond the diff.
- Trailers and collaboration: show how to include Co-authored-by and related task/PR references to acknowledge multiple contributors and link to discussions.
- Use cases: consistent commits for features, fixes, refactors, and reviews that improve bisectability and changelog accuracy.
Quick Start
Draft a clear subject line and an informative body for your next commit.