| name | commit-msg |
| description | Generate professional commit messages from staged changes following Chris Beams' seven rules.
Use when user stages changes and requests commit message. Triggers include:
- English: "create commit message", "generate commit message", "write commit"
- Context: User has staged changes (git add) and needs a commit message
|
Commit Message Generator
Overview
Generate professional commit messages from staged changes following Chris Beams' seven rules for commit messages.
⚠️ Critical Execution Rules
NEVER cd to skill folder. Always execute scripts from user's current working directory to preserve git repository context.
Workflow
Step 1: Extract Staged Changes
!git diff HEAD
Step 2: Analyze the Diff
Read the actual code changes to understand:
- What changed (high-level)
- Why this change matters
- Appropriate imperative verb (Add/Fix/Refactor/Update/etc.)
Step 2b:
The Subject line must start with the JIRA issue. Ex VIX-XXXX This is typically the branch name.
Step 3: Generate Commit Message
Follow Chris Beams' seven rules:
- Separate subject from body with blank line
- Limit subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use imperative mood ("Fix bug" not "Fixed bug")
- Wrap body at 72 characters
- Explain what and why, not how
Format:
Subject line (50 chars max, imperative, capitalized, no period)
Body paragraph explaining WHY this change was needed and WHAT
it accomplishes (not HOW). Wrap at 72 characters per line.
Can include multiple paragraphs, bullet points, or issue refs.
Related to VIX-XXXX
Step 4: Present to User in format to be pasted into commit message
VIX-XXXX Prevent token expiration race condition
Expired tokens were accepted during brief window between
expiry and cache invalidation, allowing unauthorized access.
Add expiry validation before processing requests and
implement immediate cache invalidation on token expiry.
Reference
See docs\references\commit-guide.md for detailed explanation of the seven rules with examples.
Examples
Simple change:
VIX-XXXX Add user email validation
Email addresses were accepted without format validation,
causing database errors when invalid emails were stored.
Add regex validation before saving to ensure valid format.
Bug fix:
VIX-XXXX Fix race condition in token refresh
Background token refresh could override user-initiated
refresh, causing authentication failures.
Add mutex lock around refresh operations to prevent
concurrent modifications.
Related to VIX-XXXX
Feature addition:
VIX-XXXX Add dark mode toggle to settings
Users requested ability to switch between light and dark
themes without changing system preferences.
Implement theme toggle in settings page with localStorage
persistence across sessions.
Depends on VIX-XXXX
