Skip to content
Skillpedia
General coding40k · #5057

commit-message-storyteller

Helps your agent create commit messages that explain the reason for changes. It makes tracking project history and team collaboration easier.

What it does

This tool creates 'commit' messages (records of code changes) that explain why a change was made, not just what changed. It follows a standard format to help other developers understand the code's history.

When to use it

  • ✓When you want to write a commit message.
  • ✓When you paste a summary of your changes (diff) and ask for a description.
  • ✓When you want a clearer code history for team or open-source projects.

Example of what to ask your AI

“Write a commit message for the following changes: [paste your change summary here]”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/github/awesome-copilot/blob/main/skills/commit-message-storyteller/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/github/awesome-copilot/blob/main/skills/commit-message-storyteller/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The tool analyzes what changed in the code and why you made the change. It then uses this information to create a clear commit message, following a specific format that explains the reason for the change.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add github/awesome-copilot --skill commit-message-storyteller

Or download just the file:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/commit-message-storyteller/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

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", "help me commit", or "generate a commit"
  • 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 diff or git diff --staged
  • A 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:

  1. What changed — files, functions, logic affected
  2. Why it changed — bug fix, new feature, refactor, performance, etc.
  3. 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
chore Build process, dependency updates, config changes
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 #789
  • Mark 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 #312

Story 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

…
FAQ

What is a 'commit'?

A commit is like a 'save' in the history of a programming project. It records a set of changes made to the code.

What is 'Conventional Commits'?

It's a set of simple rules for creating commit messages. It helps standardize how changes are described, making them easier to read and automate.

What is 'git diff'?

It's a command that shows the differences between versions of your code. It's like a 'before and after' of your changes.

Details

Original description by the author

Analyzes git diffs or staged changes and generates narrative commit messages that explain WHY a change was made, not just what changed — following Conventional Commits format. Use when asked to "write a commit message", "generate a commit", "describe my changes", "what should I commit this as", "commit this", "summarize my diff", or "help me commit". Works with git diff output, staged files, or pl

repo: github/awesome-copilot

Popularity

GitHub stars
40k
Ranking position
#5057
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills