agentleFS
mukundzhamukundzha/clws/.cursor/skills/changelog-writer/SKILL.md

changelog-writer

Skill0 starsChanged 49 days agoMITView on GitHub

Write or update CHANGELOG.md entries, or release notes as an entry list, from a diff, commit range, git log, or merged PRs. Use whenever the user mentions "changelog", "CHANGELOG.md", or "what changed in this release", even without naming a file. Not for commit messages, PR descriptions, or announcement prose.

21 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use regex-builder, test-writer and 1 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.
  • jMertaSkill

    regex-builder

    Use when the user asks to create, debug, explain, validate, or optimize a regular expression or replacement for a specific engine. Verifies representative matches, non-matches, captures, escaping, portability limits, and backtracking risk in the target runtime.

    Also in 3 projects that use this

  • leonardomsoSkill

    test-writer

    Generate comprehensive Vitest tests for code examples in JavaScript concept documentation pages, following project conventions and referencing source lines

    Also in 5 projects that use this

  • glinckerSkill

    readme-generator

    Generates comprehensive README.md files for software projects by analyzing codebase structure

    Also in 6 projects that use this

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 19 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write for a user deciding whether to upgrade who hasn't seen the diff.

    line 11
  2. Very specific:

    Put unshipped work under ## [Unreleased].

    line 23
  3. Distinctive:

    Default categories: Added, Changed, Deprecated, Removed, Fixed, Security.

    line 35
  4. Distinctive:

    No file, or user asked "release notes" / "what changed": print the entry list only, no file write.

    line 67
  5. Distinctive:

    No file and user said "create/update changelog": create with this header, then the version section:

    line 68
  6. Distinctive:

    Never mix modes: either edit the file or print the list, not both, unless asked.

    line 73

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

Changelog Writer

Write for a user deciding whether to upgrade who hasn't seen the diff. They ask: does it break me, what must I do, is my bug fixed?

Workflow

  1. Determine range: explicit version/range from user wins. Else last tag via git tag --sort=-v:refname | head -5. Else ## [Unreleased].
  2. Collect evidence, in order: git log <since>..HEAD --oneline, git diff <since>..HEAD --stat, then full git diff <since>..HEAD for touched areas only. Shortcut: bash <skill-dir>/scripts/collect-changes.sh [<since>] [--stat-only], where <skill-dir> is the folder containing this SKILL.md. Manual bullets: use as leads, still verify against diff when available.
  3. Filter through Scope, draft Entries, mark Breaking changes, then run Before output checks.

Source

  • The existing file wins: copy its categories, tense, dates, and link style from the last 2-3 entries. No file: Keep a Changelog (## [1.2.0] - YYYY-MM-DD), past tense.
  • The diff is the evidence. Commit messages and PR titles are written mid-work: use them as leads.
  • Put unshipped work under ## [Unreleased]. Never invent a version or date.

Scope

Include only what an upgrading user would notice: public signatures, CLI flags, output format, exit codes, response shapes, config keys, defaults, visible errors, supported platforms and runtimes.

Skip refactors, tests, CI, formatting, docs, typo fixes, and dependency bumps, unless the bump changes what users must install or closes a CVE.

A bug introduced and fixed within one release never shipped: fold the fix into its Added or Changed entry. Added then reverted: no entry.

Entries

Default categories: Added, Changed, Deprecated, Removed, Fixed, Security. Omit empty ones.

  • Changed: state old and new behavior.
  • Deprecated: name the replacement and the removal version.
  • Fixed: describe the symptom and its trigger, not the cause.
  • Security: cite the CVE/GHSA ID and affected versions. Give no exploit detail.

One change per line, in its own category, verb first. Test: could a user tell what changed without reading the code?

Reduced cold-start time from ~800ms to ~150ms by lazy-loading plugins.

An entry that reduces to a vague word (various, misc, several, some, minor, improved, updated, enhanced) fails the test. State the observable difference from the diff. If you can't tell, flag it for the maintainer.

Numbers only from the diff or PR. Name a symbol or file only if users touch it. Facts, no adjectives.

Breaking changes

Any change that breaks existing usage, every Removed included, gets **BREAKING:** at the start of its own entry, never in a footnote. State the change and the migration; add the reason only if the migration looks arbitrary. An entry without a migration step is a support ticket.

BREAKING: --output now defaults to json (was text). Pass --output text to keep the old behavior.

Version

Any BREAKING entry: major. Added or Deprecated: minor. Fixed or Security only: patch. Pre-1.0, breaking bumps minor. If the requested version contradicts the entries, say so, then use it.

Before output

Squash "start X", "fix X", "actually fix X" into one entry. Within a category: BREAKING first, then by users affected. Reread as a user who never saw the diff; fix or cut any line that needs it. Three real changes means three lines.

Output

  • CHANGELOG.md exists or user said "update": patch the file in place. Match its heading level, keep existing link refs at the bottom, add new ones only if the file uses them.
  • No file, or user asked "release notes" / "what changed": print the entry list only, no file write.
  • No file and user said "create/update changelog": create with this header, then the version section:
    # Changelog
    All notable changes to this project will be documented in this file.
  • Never mix modes: either edit the file or print the list, not both, unless asked.

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.