agentleFS
tenstorrenttenstorrent/tt-studio/.claude/skills/draft-release-notes/SKILL.md

draft-release-notes

Skill52 starsChanged 28 days agoApache-2.0View on GitHub

Draft TT-Studio GitHub release notes in the house style: study the last one or two published releases for structure and voice, diff the current release branch against the previous release tag/commit, then group the changes into πŸš€ New Features / πŸ› Bug Fixes / πŸ”§ Technical Improvements with bold feature names and short descriptions. Use whenever someone asks to "draft a release note", "write release notes for vX.Y.Z", or "make release notes from the rc-vX.Y.Z branch". Delivers the final result as a copyable markdown code block.

9 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 9 edited versions we read keep these.

  • 3

    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. Very specific:

    Follow this when asked to draft release notes for a new TT-Studio version.

    line 15
  2. Distinctive:

    If the user names a branch, use it.

    line 26
  3. Distinctive:

    Read the most recent two or three published release descriptions so the new one matches their structure and voice:

    line 35
  4. Very specific:

    If the release PR number is known, link it: #<PR>.

    line 97
  5. Distinctive:

    Always hand back the final release note inside a fenced markdown code block so it's copy-pasteable verbatim into GitHub.

    line 104

β€œCommon” is measured: kept by at least 6 in 10 of the 9 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

TT-Studio Release Notes Drafting

Follow this when asked to draft release notes for a new TT-Studio version. The goal is notes that read exactly like the previous few releases β€” same sections, same voice, same level of detail β€” built from the actual changes on the release branch.

Inputs to confirm

  • New version (e.g. v2.9.0) and the release branch (e.g. rc-v2.9.0).
  • Previous version it ships after (e.g. v2.8.0). If not given, it's the most recent published GitHub release.

If the user names a branch, use it. Don't guess a version β€” ask if unclear.

The release PR into main is titled Rc vX.Y.Z (the Lint PR title check is skipped for rc-* head branches) or release: vX.Y.Z β€” see CONTRIBUTING β†’ Release Process. Step 2 relies on that Rc vX.Y.Z merge-commit title as the cutoff.

Step 1 β€” Study the previous releases (match the style, don't invent it)

Read the most recent two or three published release descriptions so the new one matches their structure and voice:

# needs no auth:
WebFetch https://github.com/tenstorrent/tt-studio/releases

The established house style is:

  • A header line: ## :rocket: TT Studio <version> is out!
  • A lead-in: A few highlights since <previous version>:
  • Three sections, in this order, each only if it has content:
    • ### πŸš€ New Features β€” bold feature name + one-line description
    • ### πŸ› Bug Fixes β€” one line each, past tense ("Fixed…", "Resolved…")
    • ### πŸ”§ Technical Improvements β€” internal/infra/CI/refactor/dep bumps
  • A closing Full changelog β†’ <link> line.

Bold-name-plus-description is the signature of the New Features section β€” keep it. Bug Fixes and Technical Improvements are plain one-liners.

Step 2 β€” Gather the actual changes

Fetch the release branch and list every commit since the previous release. Each release's RC merge commit is titled like Rc vX.Y.Z (#NNNN) β€” the previous release's merge commit is the cutoff; everything above it is new.

git fetch origin <release-branch>
git log origin/<release-branch> --oneline -60

Find the previous release's Rc v<prev> (#NNNN) commit in the list; everything above it belongs in these notes. Commit subjects are usually descriptive enough (they're squash-merged PR titles). If a subject is cryptic, inspect it with git show --stat <sha> rather than guessing.

Step 3 β€” Categorize

Sort each change into one of the three sections:

  • πŸš€ New Features β€” user-facing capabilities and additions (new models, new UI, new commands/flags, new workflows). Utilize next heading for model-related updates if this gets too long.
  • πŸ€– Model Support (Optional) β€” if there are too many model-related changes, then things like the addition of new models, progress stuff, deployment improvements, etc go here.
  • πŸ› Bug Fixes β€” anything fixing broken behavior. Past tense.
  • πŸ”§ Technical Improvements β€” refactors, dependency/artifact bumps, CI, internal plumbing, dev-experience changes not visible to end users.

Judgment calls to make deliberately (and mention to the user afterward):

  • Internal output-handling or plumbing changes go in Technical Improvements, not New Features, even when they sound feature-ish.
  • Fold several closely related commits into one bullet (e.g. multiple CI additions β†’ one "Added CI: …" bullet; several workflow-canvas commits β†’ one "Workflow Canvas Upgrades" bullet with the pieces listed).
  • CI-only / internal changes can be bundled or dropped from public notes β€” offer the user both.

Step 4 β€” Changelog link

  • If the release PR number is known, link it: #<PR>.
  • Otherwise use a compare link: https://github.com/tenstorrent/tt-studio/compare/<prev>...<new> (resolves once the RC merges and is tagged).

Tell the user which one you used and offer to swap in the PR number.

Step 5 β€” Deliver as a markdown code block

Always hand back the final release note inside a fenced markdown code block so it's copy-pasteable verbatim into GitHub. Do not render it as live markdown.

Then, below the code block, add a short plain-text note of the judgment calls you made (what you grouped, what you moved between sections, which changelog link you chose) and any options you want the user to weigh in on.

Template

```markdown
## :rocket: TT Studio <version> is out!

A few highlights since <previous version>:

### πŸš€ New Features
- **<Feature Name>**: <one-line description>
- ...

### πŸ› Bug Fixes
- Fixed <…>
- ...

### πŸ”§ Technical Improvements
- <…>
- ...

**Full changelog β†’ <link>**
```

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.