agentleFS
it-bensit-bens/cc-port/.claude/skills/writing-release-notes/SKILL.md

writing-release-notes

Skill6 starsChanged 22 days agoMITView on GitHub

Use when drafting release notes for a cc-port version tag.

8 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use applying-template-updates, authoring-issues-prs 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.
  • pvliesdonkSkill

    applying-template-updates

    Use when asked to work through, apply, resolve or review a template update pull request (the weekly `copier/update` branch opened by the copier-update workflow), after running `copier update --trust` by hand, or when a template update looks like it leaves no room for something this project needs.

    Also in 3 projects that use this

  • pvliesdonkSkill

    authoring-issues-prs

    Use when filing a bug, opening or creating a GitHub issue, drafting an epic or ticket, writing up a finding or review observation worth tracking, sizing a change before coding, or opening a pull request for this repository. Routes the change to the right repo first (library / template / domain), picks the right issue form, sizes the change to one PR, links epic children as native sub-issues, and applies CONTRIBUTING.md before anything is posted.

    Also in 3 projects that use this

  • zpower426Skill

    roadmapping

    Communicate the product evolution timeline and key milestones, balancing long-term goals with short-term delivery.

    Also in 3 projects that use this

  • quocldSkill

    logging-standard

    Use when writing or reviewing code that logs, when creating or changing a logger, request or job correlation, or log redaction, and when the user says "setup log", "setup logger", "thêm log", "chuẩn hoá log", "log bị lộ token", "log quá nhiều", "review log".

    Also in 3 projects that use this

  • nilecuiSkill

    writing-documentation

    Produces concise, clear documentation by applying Elements of Style principles. Use when writing or improving any technical documentation (READMEs, guides, API docs, architecture docs). Not for code comments.

    Also in 3 projects that use this

  • +7 more from pvliesdonk

The file

We split this skill into the rules it gives an agent

9 rules. 0 are common, 6 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No previous tag (first release): range is <initial-commit>..HEAD.

    line 81
  2. Distinctive:

    When the range is otherwise ambiguous (two plausible previous tags, unusual tag pattern), confirm with the user before continuing.

    line 83
  3. Distinctive:

    Every line in the eventual draft must trace to a PR body, a commit subject, or a diff hunk read here.

    line 102
  4. Distinctive:

    Test-only PRs unless the release is test-focused.

    line 128
  5. Very specific:

    If any breaking change is present, the notes must include ### Breaking Changes with migration guidance.

    line 142
  6. Distinctive:

    Use this exact skeleton:

    line 153
  7. Very specific:

    Always include the ### Upgrade Notes section.

    line 188
  8. Distinctive:

    Search for em dash (—) and en dash (–).

    line 195
  9. Distinctive:

    Check for banned sentence patterns and hedging filler.

    line 197

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

Writing Release Notes

Requirements

  • Version: a tag like v0.5.0. Ask if missing. Accept with or without leading v; emit canonical v form in output.
  • Working directory: cc-port repository root.
  • Repository must be a git checkout with tags fetched (git fetch --tags if unsure).
  • cc-port releases are tag-driven via goreleaser; there is no release PR to read from. Aggregate from the tag range.

Workflow

digraph release_notes {
    entry [shape=doublecircle, label="Version?"];
    fetch_tags [shape=box, label="List tags +\ncheck target"];
    prev_exists [shape=diamond, label="Previous tag\nexists?"];
    first_release [shape=box, label="Range =\ninitial-commit..HEAD\n(note in summary)"];
    target_exists [shape=diamond, label="Target tag\nexists?"];
    range_tag [shape=box, label="Range =\nprev..target"];
    ask_head [shape=box, label="AskUser:\nconfirm HEAD"];
    range_head [shape=box, label="Range =\nprev..HEAD"];
    list_prs [shape=box, label="List merged PRs"];
    fetch_pr [shape=box, label="Fetch PR details"];
    categorise [shape=box, label="Categorise"];
    filter [shape=box, label="Filter"];
    breaking [shape=diamond, label="Breaking?"];
    flag_break [shape=box, label="Require Breaking\nChanges section"];
    title [shape=box, label="Generate title"];
    draft [shape=box, label="Draft notes"];
    antislop [shape=box, label="Anti-slop pass"];
    clean [shape=diamond, label="Clean?"];
    present [shape=doublecircle, label="Present output"];

    entry -> fetch_tags;
    fetch_tags -> prev_exists;
    prev_exists -> first_release [label="no"];
    prev_exists -> target_exists [label="yes"];
    target_exists -> range_tag [label="yes"];
    target_exists -> ask_head [label="no"];
    ask_head -> range_head;
    first_release -> list_prs;
    range_tag -> list_prs;
    range_head -> list_prs;
    list_prs -> fetch_pr;
    fetch_pr -> categorise;
    categorise -> filter;
    filter -> breaking;
    breaking -> flag_break [label="yes"];
    breaking -> title [label="no"];
    flag_break -> title;
    title -> draft;
    draft -> antislop;
    antislop -> clean;
    clean -> antislop [label="no, rewrite"];
    clean -> present [label="yes"];
}

Resolve version range

Run in parallel:

# Sorted tags, newest first
git tag --sort=-v:refname

# Whether the target tag exists locally
git rev-parse "refs/tags/<version>" 2>/dev/null || echo TAG_NOT_FOUND

From the sorted tag list, pick the tag immediately before <version>.

  • Target tag exists, previous tag exists: range is <prev>..<version>.
  • Target tag does not exist, previous tag exists: range is <prev>..HEAD. AskUserQuestion to confirm HEAD is the intended endpoint before proceeding.
  • No previous tag (first release): range is <initial-commit>..HEAD. Note this in the Summary.

When the range is otherwise ambiguous (two plausible previous tags, unusual tag pattern), confirm with the user before continuing.

List merged PRs

Run:

git log <range> --pretty=format:"%H %s" --no-merges
git diff <range> --stat

Extract PR numbers from commit subjects. cc-port commits land via squash-merge with the trailing (#N) suffix added by GitHub.

For commits without a trailing (#N) (direct pushes from before the PR workflow), include the commit subject verbatim and treat the commit as its own change unit.

Fetch PR details

For each PR number, call gh-tooling pr_view to read title, body, and labels. For ambiguous commits without PRs, call gh-tooling commit_pulls with the commit SHA to confirm whether a PR exists.

Every line in the eventual draft must trace to a PR body, a commit subject, or a diff hunk read here. Do not invent change descriptions or migration steps.

Categorise

Map each PR to one cc-port category. Use the conventional-commit prefix on the PR title as the primary signal, falling back to changed paths.

CategoryPrefix or path signal
Featuresfeat:, feat(scope):
Fixesfix:, fix(scope):
Refactorsrefactor:
Performanceperf:
Build / Releasebuild:, .goreleaser.yml, packaging
CIci:, .github/workflows/
Documentationdocs:, README.md, docs/, AGENTS.md
Dependenciesdeps:, chore(deps):, go.mod, go.sum
Teststest:, only *_test.go files touched
Chorechore: and anything not covered above

Group by cc-port module under each category when more than two PRs share a module. Modules are listed in AGENTS.md §Navigation.

Filter

Exclude from the user-facing notes:

  • Version-bump-only commits (the release implies them).
  • Test-only PRs unless the release is test-focused.
  • Internal refactors with no observable effect, unless they unblock something the user cares about.
  • Renovate / Dependabot dep bumps with no functional change. Roll them into a single Dependencies line with the count.

Detect breaking changes

Mark a PR as breaking if any apply:

  • PR body contains BREAKING CHANGE: or title carries ! after the type.
  • Removed CLI subcommand or flag (check cmd/cc-port diffs).
  • Removed or renamed exported symbol that another module references.
  • Changed manifest XML schema in a way that older archives no longer load.
  • Changed lock-file or session-keyed registry contracts (see internal/lock/README.md, internal/tool/claude/README.md).

If any breaking change is present, the notes must include ### Breaking Changes with migration guidance.

Generate title

A descriptive 3-6 word title that captures the release theme.

  • Single-focus release: name the main change. Example: Manifest XML Validation.
  • Multi-feature release: combine themes. Example: Import Cap Guards & Homebrew Cask.

Draft notes

Use this exact skeleton:

## v{version} - {Title}

### Summary

{1-3 sentences. Start with an action verb. Name the user-visible effect.}

### Changes

#### {Category}

- {Description starting with an action verb. Name the user-visible effect.} (#{pr-number})

{repeat per category}

### Breaking Changes

{Only if any. Describe what breaks and the migration path. Include code or command examples when they shorten the explanation.}

### Upgrade Notes

{Either concrete upgrade steps, or the literal line: `No breaking changes.`}

Format rules:

  • Title line is ## v{version} - {Title}. Becomes the GitHub release title.
  • Categories use ####. Omit a category if it has no entries.
  • Sort categories in the order listed in the Categorise step. Within a category, order by user impact: features first, then incremental polish.
  • One bullet per PR. Combine only when the same PR contributes to multiple subareas under one category.
  • Plain prose bullets. Lead with an action verb (Add, Fix, Refactor, Reduce); trail with the PR reference in parentheses. Do not bold a change name and follow with a colon. The - **Title**: description. pattern reads as AI slop.
  • Code examples for new commands or flags belong inline under the relevant bullet.
  • Cite each change with its PR number where one exists.
  • Always include the ### Upgrade Notes section. Use the literal No breaking changes. when no migration applies.
  • No "Generated with Claude Code" footer. Release notes carry no attribution.

Anti-slop pass

The release notes are user-facing prose. Re-read references/writing-rules-anti-ai-slop.md and check the draft literally:

  1. Search for em dash (—) and en dash (–). Remove every instance.
  2. Re-read each word against the banned vocabulary list.
  3. Check for banned sentence patterns and hedging filler.
  4. Scan for - **Title**: description. bullets. Rewrite them as plain prose bullets that lead with an action verb.
  5. Vary sentence rhythm. Do not let every bullet be the same length.

Rewrite affected text and re-check. Do not exit this step until the draft passes every check.

Present

Output:

  1. A short header: version, previous tag, PR count.
  2. The release notes inside a fenced markdown block so the user can copy-paste.
  3. Offer to copy the notes (without fences) to the clipboard via pbcopy (macOS) or xclip -selection clipboard (Linux). Ask first.

The session's gh-tooling MCP is read-only. The user applies the notes themselves; do not attempt to mutate the release via gh-tooling or the gh CLI.

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.