release-notes
Skill48 starsChanged 51 days agoMITView on GitHub
Write release notes or a changelog entry that tell existing users what they will notice after updating, with the technical detail after it. Use when publishing a release, writing a changelog, or editing release notes.
- Commits and pushes
176 other projects use a version of this.
Adopted by
Most recently taken up by
- facebook/bpfiltertheir own version, first seen Nov 9, 2026
- openfrontio/OpenFrontIOtheir own version, first seen Nov 8, 2026
- microsoft/agent-frameworktheir own version, first seen Nov 8, 2026
- paulocsb/worldcup-fifa-pooltheir own version, first seen Nov 8, 2026
- OldemarJesus/connectlife-mcp-servertheir own version, first seen Nov 8, 2026
- op3616windows/skillstheir own version, first seen Nov 8, 2026
Used with
Projects with it also use brainstorm-experiments-existing, brainstorm-ideas-new and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
skytiger6724Skillbrainstorm-experiments-existing
Design experiments to test assumptions for an existing product — prototypes, A/B tests, spikes, and other low-effort validation methods. Use when validating assumptions, testing feature ideas cheaply, or planning product experiments.
Also in 6 projects that use this
skytiger6724Skillbrainstorm-ideas-new
Brainstorm feature ideas for a new product in initial discovery from PM, Designer, and Engineer perspectives. Use when starting product discovery for a new product, exploring features for a startup idea, or doing initial ideation.
Also in 6 projects that use this
45ckSkillpestle-analysis
Also in 6 projects that use this
About-IntelligenceSkillpositioning-ideas
Brainstorm product positioning ideas differentiated from competitors.
Also in 6 projects that use this
About-IntelligenceSkillproduct-name
Brainstorm 5 unique, memorable product names with rationale aligned to brand values and target audience.
Also in 6 projects that use this
- +7 more from skytiger6724
Other versions176 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 176
- tw93/Mole★ 74ksame name
- makeplane/plane★ 62ksame name
- tabler/tabler★ 42ksame name
- pnpm/pnpm★ 37ksame name
- quasarframework/quasar★ 27ksame name
- dotnet/core★ 22ksame name
- zauberzeug/nicegui★ 16ksame name
- adobe/react-spectrum★ 16ksame name
- espanso/espanso★ 15ksame name
- microsoft/agent-framework★ 15ksame name
166 more not listed
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 repository19 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- skills/vignette-todo-run/launchers/claude.mdCLAUDE.md
- catch-upSkill
- clean-copySkill
- code-commentsSkill
- deep-researchSkill
- discernment-nudgeSkill
- exhaustive-systems-analysisSkill
- frame-checkSkill
- herdr-namesSkill
- latent-potentialSkill
- plainSkill
- pr-descriptionSkill
- pr-screenshot-comparisonSkill
- pr-self-reviewSkill
- refine-proseSkill
- spikeSkill
- vignette-todo-runSkill
The file
We split this skill into the rules it gives an agent
6 rules. 0 are common, 6 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 162 edited versions we read keep these.
6
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 13
Read a change's diff when its commit subject doesn't make the user's experience clear.
- Distinctive: line 21
A picture of the headline change: when it is visible. Reuse the before-and-after image from the PR that made the change when there is one.
- Distinctive: line 23
Also: Every other change a user can notice, one bullet each, grouped under a bold heading per app or platform, with "Every app" first.
- Distinctive: line 27
When nothing in a release is visible, say so in the first line, and keep only Update and Under the hood.
- Distinctive: line 43
Not text to copy:
- Distinctive: line 76
Follow the project's release doc for when and how to publish.
“Common” is measured: kept by at least 6 in 10 of the 162 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
Release notes
Write for someone who already uses the product. They want to know what will feel different after they update, and whether they have to do anything. Most read the first line and stop. Some scan the highlights. Few read further. Notes they can scan in seconds beat complete notes they skip.
Gather
- List the changes since the last release, such as with
git log --oneline <last tag>..HEAD. Read the PRs and issues they reference. - Read a change's diff when its commit subject doesn't make the user's experience clear. Describe only effects you can trace to a change.
- Find the project's update steps and the apps or platforms it ships to. Look in its release doc, its README, and the last release's notes.
Shape
In this order:
- One bold line on the effect users will notice most. Name the effect, not the area: "Other mods' notes come back above your prompt", not "Fixes for the band".
- A picture of the headline change when it is visible. Reuse the before-and-after image from the PR that made the change when there is one.
- Highlights. Three to five bullets: the changes most users will run into. Each starts with a bold label of a few words, then one short sentence.
- Also. Every other change a user can notice, one bullet each, grouped under a bold heading per app or platform, with "Every app" first. Leave out a group with no changes.
- Update. The project's update steps, as the last release gave them, changed only where this release changes them.
- Under the hood, inside
<details><summary>Under the hood</summary>, so it starts closed. One line per change that a technical user or contributor would want to know: the mechanism behind a change above, a fix with no visible effect, a changed file format or API. Link the issue or PR when there is one, and thank the person who reported it. Work that does not ship in the product, such as a video, a plan, or a refactor with no effect, stays out.
When nothing in a release is visible, say so in the first line, and keep only Update and Under the hood.
Each item
- One line, one change. Say what the user sees or does now. Add how it was before only when they could not recognize the change without it.
- Leave out a change nobody acts on or notices, or move it under the hood.
- Put anything the user must do inside the item it belongs to, such as "reopen the tab once". A step that applies to the whole release goes in Update.
- Use the names users see on screen: button labels, tab names, and messages, quoted exactly. Name the place in plain words, such as "the terminal" or "the Codex tab". Code names and the project's own terms for its parts belong under the hood.
- Order items by how often users run into them. A change everyone sees comes before an edge case. A removed feature or a change that breaks a workflow goes in Highlights, with what to do instead.
Check
Before publishing, give only the notes to a reader with no other context. Ask what they will notice after updating and whether they must do anything. Rewrite when either answer is wrong. When you have no way to hand the notes to a separate reader, skip this step and say so in your handoff.
Example
Not text to copy:
**Other mods' notes come back above your prompt, and commands only you can run now copy to your clipboard.**
## Highlights
- **Other mods' notes show again.** The band above the prompt shows the inbox's line, then other mods' notes under it.
- **Your commands copy.** A step the agent can't run, such as one on a phone plugged into your computer, copies its command when you press it.
## Also
**Codex**
- Updates stop breaking the Inbox tab. After this update, quit and reopen the ChatGPT app once.
## Update
- **Claude Code:** run `claude plugin marketplace update inbox`, then `claude plugin update inbox`, then `/reload-plugins` in any session that's already open.
- **Codex:** run `codex plugin marketplace upgrade`, then `codex plugin add inbox@inbox`.
<details>
<summary>Under the hood</summary>
- The band keeps what later mods draw in it (#4, reported by @fahadjibransheikh).
- A command the agent asks you to run is marked as a terminal step, so it copies instead of going to the agent.
- Codex deletes a plugin's old folder when it updates. The Codex server now loads the newest installed version after that, instead of failing with a module error.
</details>Publishing
Follow the project's release doc for when and how to publish. Writing the notes does not authorize publishing them. Publish with gh release create <tag> --notes-file <file> or gh release edit <tag> --notes-file <file>, then re-read the published body with gh release view <tag> --json body.
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.

