write-release-notes
Skill4 starsChanged 5 months agoMITView on GitHub
Turn a commit history into polished, grouped release notes in RELEASE_NOTES.md. Groups changes by type, highlights breaking changes, and never invents changes that are not in the history.
6 other projects use a version of this.
Adopted by
Most recently taken up by
- spiceai/spiceaitheir own version, first seen Nov 1, 2026
- koruworks/skillstheir own version, first seen Nov 1, 2026
- tada5hi/skillstheir own version, first seen Nov 1, 2026
- arthjean/skillstheir own version, first seen Nov 1, 2026
- imbue-ai/sculptortheir own version, first seen Oct 8, 2026
- tldraw/tldrawtheir own version, first seen Oct 8, 2026
Other versions6 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 6
- tldraw/tldraw★ 51ksame name
- spiceai/spiceai★ 3.1ksame name
- imbue-ai/sculptor★ 246same name
- arthjean/skills★ 3same name
- tada5hi/skills★ 2same name
- koruworks/skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- commit-push-prSkill
- fix-failing-testsSkill
- review-diffSkill
- validate-configSkill
The file
We split this skill into the rules it gives an agent
7 rules. 0 are common, 5 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 6 edited versions we read keep these.
5
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 12
Read the project's commit history and produce a RELEASE_NOTES.md file with the changes grouped into clear sections, written for end users …
- Distinctive: line 16
Use when the user asks to write release notes, draft a release announcement, or summarize changes for a release.
- Distinctive: line 23
Do NOT trigger for questions that merely ask about the commit history (counting commits, showing the log, explaining a change).
- Distinctive: line 29
Check the sources in this order and use the first that exists:
- Very specific: line 49
Create RELEASE_NOTES.md in the repository root with this structure:
- Distinctive: line 69
Breaking Changes comes first: when there are any, and each entry explains what users must do to migrate.
- Distinctive: line 72
Never invent a change: Every bullet must trace back to a specific commit in the history.
“Common” is measured: kept by at least 6 in 10 of the 6 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
What I do
Read the project's commit history and produce a RELEASE_NOTES.md file with the changes grouped into clear sections, written for end users rather than developers. I highlight breaking changes prominently and never mention a change that is not present in the history.
When to use me
Use when the user asks to write release notes, draft a release announcement, or summarize changes for a release. Trigger on phrases like:
- "write release notes"
- "draft the release notes for this release"
- "turn the changelog/commits into release notes"
- "prepare the release announcement"
Do NOT trigger for questions that merely ask about the commit history (counting commits, showing the log, explaining a change).
Steps
Step 1: Collect the commit history
Check the sources in this order and use the first that exists:
- A
commits.txtfile in the repository root (one commit per line). git log --oneline <last-tag>..HEADif the repository has tags (git describe --tags --abbrev=0).git log --oneline(full history) as a fallback.
Step 2: Classify each commit
Parse Conventional Commit prefixes when present:
feat:→ Featuresfix:→ Fixesperf:→ Performance- A
!after the type (e.g.feat!:) or aBREAKING CHANGEmarker → Breaking Changes (in addition to its own section) docs:,chore:,refactor:,test:,ci:→ omit from the notes unless they are user-visible
For commits without a conventional prefix, infer the category from the message; if unclear, put them under Other Changes.
Step 3: Write RELEASE_NOTES.md
Create RELEASE_NOTES.md in the repository root with this structure:
# Release Notes
## Breaking Changes
- ...migration guidance included...
## Features
- ...
## Fixes
- ...Rules:
- Breaking Changes comes first when there are any, and each entry explains what users must do to migrate.
- Rewrite commit subjects into user-facing language (e.g. "fix: handle empty input in parser" → "Fixed a crash when the input file is empty").
- One bullet per change. Omit empty sections.
- Never invent a change. Every bullet must trace back to a specific commit in the history. Do not embellish with features, dates, version numbers, or contributors that are not in the source data.
Step 4: Report
Tell the user the file was created and summarize the section counts (e.g. "1 breaking change, 3 features, 4 fixes").
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

