agentleFS
WireCatLabsWireCatLabs/wirecat-desktop/.claude/skills/release-notes/SKILL.md

release-notes

Skill4 starsChanged 7 days agoApache-2.0View on GitHub

Write the plain-language release notes for a WireCat Desktop version into docs/releases/<version>.md before bin/tag-release. Use when asked to prepare a release, write release notes, or when bin/tag-release says the notes file is missing.

181 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
  • Other versions181 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 181

    1. tw93/Mole★ 74ksame name
    2. makeplane/plane★ 62ksame name
    3. tabler/tabler★ 42ksame name
    4. pnpm/pnpm★ 37ksame name
    5. quasarframework/quasar★ 27ksame name
    6. dotnet/core★ 22ksame name
    7. zauberzeug/nicegui★ 16ksame name
    8. adobe/react-spectrum★ 16ksame name
    9. espanso/espanso★ 15ksame name
    10. formbricks/formbricks★ 13ksame name

    171 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 repository3 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 4 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 167 edited versions we read keep these.

  • 4

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

    Write it for people who use the app, not for people who build it.

    line 11
  2. Distinctive:

    Read each PR body, not only its title.

    line 20
  3. Very specific:

    Write docs/releases/<version>.md in this shape, in this order:

    line 21
  4. Distinctive:

    Leave out a section that has nothing in it.

    line 42
  5. Very specific:

    No jargon, no internal ids (A11, NEED-, WC-SECR-), no author names, no semicolons, no long dashes, no hype words ("powerful", "seamless", …

    line 48
  6. Distinctive:

    Do not edit the published GitHub release by hand.

    line 55

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

bin/tag-release refuses to tag until docs/releases/<version>.md exists. The release workflow publishes that file as the body of the GitHub release, and the update dialog shows its text before "All changes".

Write it for people who use the app, not for people who build it.

Steps

  1. Version: jq -r .version package.json. Previous tag: git describe --tags --abbrev=0.
  2. List what reached main since that tag: gh pr list --state merged --base main --search "merged:>$(git log -1 --format=%cI <prev-tag>)" --limit 200 --json number,title,body. Cross-check with git log <prev-tag>..HEAD --oneline: some commits have no PR, and a PR merged before the tag date may still be in the range.
  3. Read each PR body, not only its title. Work out what a user will notice.
  4. Write docs/releases/<version>.md in this shape, in this order:
One or two sentences: what this version is about.

## New
- What a user can now do, in plain words.

## Improved
- What works better, or is easier.

## Fixed
- What was broken and now is not.

## Known issues
- Only when there are any. Leave the section out otherwise.

## All changes
- Title rewritten so a person can read it (#79)

Leave out a section that has nothing in it.

Rules

  • Say what the user sees or can do. Leave out internal refactors, tests, CI and code structure.
  • Simplified Technical English: short sentences, one idea each, common words, active voice.
  • No jargon, no internal ids (A11, NEED-, WC-SECR-), no author names, no semicolons, no long dashes, no hype words ("powerful", "seamless", "blazing").
  • Name a tool by what it is for when you can ("Telegram", "Email"), and keep command names for the one place a user needs to type them.
  • "All changes" has one line per PR: the title in plain words, then the link as (#79). No author. Keep the number as plain text, GitHub links it. Leave out docs, journal, plan, test and release-bump PRs. A change with no PR (a direct commit) gets a line without a number.
  • Do not edit the published GitHub release by hand. Commit the file, then tag.

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.