Commit Message Storyteller
GitHubOfficialFirst committed by kwekudzataDistributed by GitHub
- Skill
- Content generator
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
Commit Message Storyteller transforms raw code changes into structured, narrative-focused commit messages. By analyzing git diffs or user-provided descriptions, it helps developers articulate the intent and context behind their work, adhering to the Conventional Commits specification. It focuses on explaining the 'why' behind changes rather than just the 'what', ensuring that commit history remains informative and clear for team members and project maintainers.
What it does
- Analyzes git diffs or staged changes to extract context
- Maps changes to standard Conventional Commits types like feat, fix, or refactor
- Constructs commit messages with a subject, body, and footer
- Identifies breaking changes and adds appropriate footers
- Suggests splitting complex diffs into multiple logical commits
- Provides a plain-English summary of the generated commit message
When to use it
- When you need to write a commit message for your changes
- When you want to summarize a git diff for a pull request
- When you need to ensure your commit history follows the Conventional Commits format
- When you want to document the reasoning behind a specific code change
Advantages
- Promotes consistent commit history across projects
- Focuses on the intent and problem-solving aspect of code changes
- Automates the formatting of complex commit structures
- Helps identify and document breaking changes clearly
Usage examples
- “Write a commit message for this diff: [pasted git diff output]”
- The agent analyzes the diff and returns a formatted commit message following the Conventional Commits structure, including a subject, body, and any necessary footers.
- “Summarize my changes: I fixed the login bug where users were redirected to the wrong page after authentication.”
- The agent generates a 'fix' type commit message explaining the issue and the resolution in the required narrative format.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/github/commit-message-storyteller/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip commit-message-storyteller.zip -d .agents/skills
Documentation by kwekudzata
Commit Message Storyteller
Transforms raw git diffs and change descriptions into clear, story-driven commit messages that follow the Conventional Commits specification. Instead of "update file.js", you get messages that communicate intent, context, and impact.
When to Use This Skill
User says "write a commit message"
User pastes a git diff or describes code changes
User says "what should I commit this as?" or "summarize my diff"
User wants better commit history for their team or open-source project
User is preparing a pull request and wants meaningful commit messages
Prerequisites
Have at least one of the following ready:
Output from
git difforgit diff --stagedA description of what you changed and why
A list of modified files
How It Works
Step 1: Gather the Change Context
Ask the user (or infer from the diff) for:
What changed — files, functions, logic affected
Why it changed — bug fix, new feature, refactor, performance, etc.
Who/what triggered it — issue number, user request, tech debt, etc.
If the user provides a raw git diff, extract this context automatically from the diff.
Step 2: Identify the Commit Type
Map the change to a Conventional Commits type using this guide:
| Type | Use When |
|---|---|
feat | A new feature or capability is added |
fix | A bug or incorrect behavior is corrected |
refactor | Code restructured without changing behavior |
perf | A change that improves performance |
docs | Documentation only changes |
style | Formatting, whitespace, missing semicolons (no logic change) |
test | Adding or updating tests |
build | Build system or dependency changes |
chore | Other maintenance that does not change source or tests |
ci | CI/CD pipeline changes |
revert | Reverting a previous commit |
See references/conventional-commits-guide.md for detailed examples.
Step 3: Write the Commit Message
Follow this structure:
<type>(<optional scope>): <short imperative summary>
<body — the story: why this change was made, what problem it solves>
<footer — issue refs, breaking change notices>Rules for Each Part
Subject line (first line):
Use imperative mood: "add", "fix", "remove" — not "added" or "fixes"
Max 72 characters
No period at the end
Lowercase after the colon
Body (the story):
Explain the why, not the what (the diff already shows the what)
Describe the problem that existed before this change
Mention any alternatives considered if relevant
Keep lines under 100 characters
Separate from subject with a blank line
Footer:
Reference issues:
Closes #123,Fixes #456,Refs #789Mark breaking changes:
BREAKING CHANGE: <description>
Step 4: Generate Output
Produce the commit message in a copyable code block, followed by a one-line plain-English explanation of the story you told.
Example output:
fix(auth): prevent token refresh loop on expired sessions
When a user's session expired mid-request, the auth middleware was
triggering a token refresh, which itself failed validation and triggered
another refresh — causing an infinite retry loop that crashed the app.
This adds a recursion guard flag that aborts the refresh cycle if a
refresh is already in progress, returning a clean 401 instead.
Closes #312Story told: A silent infinite loop on session expiry was crashing the app; this stops the cycle early and returns a clean error.
Multiple Commits from One Diff
If the diff contains logically separate changes, split them into multiple commit messages and tell the user. Use this heuristic:
Different files with unrelated purposes → likely separate commits
Same file but distinct concerns (e.g., bug fix + refactor) → suggest splitting
Everything tightly coupled → one commit is fine
Edge Cases
| Situation | How to Handle |
|---|---|
| User provides no context beyond a diff | Infer type and scope from file names and changed symbols |
| Changes span many files with no clear theme | Ask: "Is this one logical change, or multiple?" |
| Breaking change detected | Add BREAKING CHANGE: footer automatically |
| User says "keep it short" | Omit body, just write a strong subject line |
| No issue number available | Omit the footer entirely |
Quick Reference
# Get your staged diff to paste into Copilot
git diff --staged
# Or get the last uncommitted working tree changes
git diffSee references/conventional-commits-guide.md for type examples and scope guidelines.
Files
- ATTRIBUTION.mdAdded by AutoGineer889 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md5.1 KiB
- references/conventional-commits-guide.md4.0 KiB
references/conventional-commits-guide.md
Conventional Commits — Quick Reference Guide
Full spec: https://www.conventionalcommits.org/en/v1.0.0/
Format
<type>(<scope>): <description>
[optional body]
[optional footer(s)]Type Examples
feat — New Feature
feat(payments): add Apple Pay support for checkout flow
Users in supported regions can now complete purchases using Apple Pay.
This reduces checkout friction and is expected to improve mobile conversion rates.
Closes #88fix — Bug Fix
fix(api): correct off-by-one error in pagination offset
The results page was skipping the last item on every page because the
offset calculation used `>` instead of `>=`. Users were missing records
silently with no error.
Fixes #201refactor — Code Restructure (no behavior change)
refactor(user-service): extract email validation into shared utility
Email validation logic was duplicated across 4 modules. Extracted into
`utils/validators.ts` so future changes only need to happen in one place.perf — Performance Improvement
perf(dashboard): lazy-load chart components to reduce initial bundle size
The dashboard was importing all chart types upfront, adding ~180KB to the
initial load. Charts are now loaded on demand, cutting initial load time
by ~40% on slow connections.docs — Documentation Only
docs(readme): add local development setup instructions
New contributors were struggling to get the dev environment running.
Added step-by-step instructions covering Node version, env vars, and
the database seed command.test — Tests Added or Updated
test(auth): add coverage for concurrent login edge cases
The login flow had no tests for simultaneous requests from the same
session. Added tests that verify only one session token is issued
when multiple requests arrive in the same tick.build — Build System / Dependencies
build(deps): upgrade eslint from v8 to v9
v8 reached end-of-life. Migrated config to flat config format required
by v9. No rule changes — this is a tooling-only update.ci — CI/CD Pipeline
ci: add caching for node_modules in GitHub Actions
Cold CI runs were taking 4+ minutes due to repeated installs.
Adding cache restore on lockfile hash reduces this to ~90 seconds.revert — Reverting a Commit
revert: feat(notifications): add push notification opt-in
Reverts commit a3f92bc.
The push notification feature caused a crash on Android 12 devices.
Rolling back until the root cause is identified.Scope Guidelines
The scope is optional but strongly recommended. It should be:
A short noun identifying the area of the codebase:
auth,api,dashboard,paymentsConsistent across the project (don't mix
userandusers)Omitted if the change is truly global
Breaking Changes
Add BREAKING CHANGE: in the footer (or use ! after the type):
feat(api)!: remove v1 endpoints
All v1 REST endpoints have been removed following the 6-month deprecation
notice. Consumers must migrate to v2 before upgrading.
BREAKING CHANGE: /api/v1/* routes no longer exist. See migration guide at docs/v2-migration.mdBody Writing Tips
Ask yourself before writing the body:
What was broken / missing before this change?
Why was this approach chosen over alternatives?
What will be different for users or developers after this?
Avoid:
Restating what the diff already shows ("changed the variable name")
Vague language ("various improvements", "miscellaneous fixes")
Future tense ("this will fix...") — write in present/past tense
Commit Message Anti-Patterns
| ❌ Bad | ✅ Better |
|---|---|
fix bug | fix(cart): prevent duplicate items on rapid add-to-cart clicks |
updates | feat(profile): allow users to update display name |
WIP | Don't commit WIP — stash it |
misc changes | Split into separate, meaningful commits |
John's changes | Describe what changed, not who changed it |
Requirements and compatibility
Written for: GitHub Copilot
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs a command-line tool
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- First committed by
kwekudzata
- Publisher
- GitHub (Official)
- Distributed by
- GitHub
- Source
- github/awesome-copilot · skills/commit-message-storyteller · commit 797337f
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Contributors
- burakkaygusuz, kwekudzata
AutoGineer is not affiliated with or endorsed by kwekudzata or GitHub.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download commit-message-storyteller.zip