agentleFS
ychampionychampion/ystack/skills/release-notes/SKILL.md

release-notes

Skill4 starsChanged 2 days agoMITView on GitHub

Write release notes for users, not developers, from git history between two versions: read the commits and PRs, drop what users can't see, group the rest by what changed for them, and write each line as a plain-language benefit, with breaking changes and required actions first. Use for "write release notes", "changelog for v2.3", "what's new since the last release", "draft the update post", or before tagging a release.

180 other projects use a version of this.

Adopted by

Most recently taken up by

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.
  • skytiger6724Skill

    brainstorm-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

  • skytiger6724Skill

    brainstorm-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

  • 45ckSkill

    pestle-analysis

    Also in 6 projects that use this

  • About-IntelligenceSkill

    positioning-ideas

    Brainstorm product positioning ideas differentiated from competitors.

    Also in 6 projects that use this

  • About-IntelligenceSkill

    product-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

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 166 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
  1. Distinctive:

    Commit messages are written for the people who wrote the code.

    line 13
  2. Distinctive:

    When a commit message is unclear, read its diff.

    line 36
  3. Distinctive:

    Leave out empty sections. Put the single most important change first in its section.

    line 65
  4. Distinctive:

    Every line traces to at least one commit or PR (keep the mapping in your working notes, not in the output).

    line 70
  5. Distinctive:

    No hype words ("blazing", "revolutionary", "seamless").

    line 78
  6. Distinctive:

    Don't publish or tag; hand the draft to the user.

    line 79

“Common” is measured: kept by at least 6 in 10 of the 166 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Release notes

Commit messages are written for the people who wrote the code. Release notes are for the people who use it. The job is to translate, and to leave out everything they don't need.

Procedure

1. Find the range

The last release tag to now (git describe --tags --abbrev=0), or the range the user gives. List commits with git log <from>..<to> --no-merges --format='%h %s'. Where the project uses pull requests, read their titles and descriptions too (gh pr list --state merged --search "merged:>=<date>"); they explain why.

2. Sort every change

BucketGoes in the notes?
Breaking: users must change somethingYes, first, with what to do
New: something users can now doYes
Improved: faster, clearer, easierYes, if a user would notice
Fixed: a bug users could hitYes, described by the symptom
Security fixYes, as "security fix in <area>"; no exploit detail before users can patch
Internal: refactors, tests, CI, deps, docs typosNo

When a commit message is unclear, read its diff. Don't guess.

3. Write each line as a user outcome

  • Lead with what the user can do or will notice, not what the code does.
    • Developer: "Refactor export pipeline to stream rows."
    • User: "Exports of large projects no longer time out."
  • Plain words. No internal names, ticket numbers or file paths unless users see them.
  • A fix names the symptom the user saw: "Fixed: the app no longer logs you out after 10 minutes."
  • One line each. Merge several commits that make one user-visible change into one line.

4. Assemble

## <version> - <date>

**Action needed**
- <breaking change>: <what to do, with the exact setting or command>

**New**
- ...

**Improved**
- ...

**Fixed**
- ...

Leave out empty sections. Put the single most important change first in its section. If the project has an existing CHANGELOG or release format, follow it instead.

5. Check

Every line traces to at least one commit or PR (keep the mapping in your working notes, not in the output). Nothing claims more than the code does. Read it as a user who never saw the code: would they know what changed and whether they need to act?

Rules

  • Users first: drop anything they can't see or act on.
  • Breaking changes always come with the action to take.
  • No hype words ("blazing", "revolutionary", "seamless").
  • Don't publish or tag; hand the draft to the user.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.