commit-messages
Invoke BEFORE committing changes
When & Why to Use This Skill
This Claude skill streamlines the version control workflow by enforcing professional and consistent commit message conventions. It helps developers maintain a clean, readable, and searchable git history by providing a structured framework for describing code changes, ensuring that every commit follows industry best practices such as specific tense usage, character limits, and standardized prefixes for features, fixes, and maintenance.
Use Cases
- Standardizing Team Contributions: Ensuring all developers on a project follow the same lowercase and past-tense conventions to maintain a unified repository style.
- Automated Change Categorization: Using specific patterns like 'fixed [issue]' or 'added [feature]' to make it easier for automated tools to generate changelogs and release notes.
- Streamlining Routine Maintenance: Quickly applying concise labels for non-functional changes such as 'vendor' for dependency updates, 'cs' for coding style fixes, or 'typos' for documentation corrections.
- Improving Code Review Efficiency: Providing clear and descriptive summaries of changes (e.g., 'Engine: refactoring traverser logic') that help reviewers understand the context before diving into the code.
| name | commit-messages |
|---|---|
| description | Invoke BEFORE committing changes |
Commit Message Style
Follow these conventions for commit messages:
Basic Rules
- Use lowercase
- No period at the end
- Use past tense for verbs ("added", "fixed" not "add", "fix")
- Nouns are fine as-is ("fix" as noun is OK, e.g. "compatibility fix")
- Keep first line under 50 characters when possible
- Write in English only
Common Patterns
- Feature additions:
added [feature](e.g., "added support for locale", "added |filter") - Bug fixes:
fixed [issue](e.g., "fixed escaping after {contentType xml}") - Improvements:
[subject]: [improvement](e.g., "Engine: refactoring", "Filters: is used as an instance") - Releases:
Released version X.Y.Z(use when bumping version and creating a tag) - Deprecations:
[method] deprecated - Breaking changes: Include "(BC break)" in message
- Work in progress:
wipfor temporary commits - Updating the /vendor folder:
vendor - Use
[subject]: [description]format when it adds clarity:CSS: reorganization- for CSS-related changesEngine: refactoring traverser logic
- Omit the subject when change affects the whole project generically
- Use lowercase for generic references:
presenters,templates,models
Routine/Maintenance Commits
Keep these simple without additional context:
vendor- for dependency updatescs- for coding style fixestypos- for typo corrections