add release-notes skill
Browse files
plugin/skills/github-release-notes/SKILL.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
name: github-release-notes
|
| 3 |
+
description: >
|
| 4 |
+
This skill should be used when the user asks to "write release notes", "generate a changelog",
|
| 5 |
+
"cut a release", "tag a version", "what shipped since", "summarize the last N commits for a
|
| 6 |
+
release", "update CHANGELOG.md", or asks for a version bump. Also triggers on "release notes
|
| 7 |
+
for v1.2", "draft the release", and "what changed between tags".
|
| 8 |
+
metadata:
|
| 9 |
+
version: "0.1.0"
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
# Release Notes + Changelog
|
| 13 |
+
|
| 14 |
+
Turn merged work into release notes a human wants to read, then publish them.
|
| 15 |
+
|
| 16 |
+
## Determine the range
|
| 17 |
+
|
| 18 |
+
1. `get_latest_release` or `list_tags` for the previous boundary.
|
| 19 |
+
2. `list_commits` with `since` the previous tag's date, or compare against the tag SHA.
|
| 20 |
+
3. `search_pull_requests` with `repo:owner/name is:merged base:main` in the window β merged PR titles and bodies are far better source material than raw commit subjects.
|
| 21 |
+
|
| 22 |
+
If the repo has no prior release, use the first commit as the boundary and say so.
|
| 23 |
+
|
| 24 |
+
## Version number
|
| 25 |
+
|
| 26 |
+
Semver, decided by content, not by habit:
|
| 27 |
+
|
| 28 |
+
- **MAJOR** β a breaking API change, a removed endpoint, a contract storage layout change, or a migration that is not backward compatible.
|
| 29 |
+
- **MINOR** β new user-visible capability, additive and backward compatible.
|
| 30 |
+
- **PATCH** β fixes and internals only.
|
| 31 |
+
|
| 32 |
+
Pre-1.0 repos: breaking changes go in MINOR. State the reasoning in one line so the user can override.
|
| 33 |
+
|
| 34 |
+
## Structure
|
| 35 |
+
|
| 36 |
+
```markdown
|
| 37 |
+
## [1.4.0] β 2026-07-30
|
| 38 |
+
|
| 39 |
+
### Added
|
| 40 |
+
- Short, user-outcome-first line. (#128)
|
| 41 |
+
|
| 42 |
+
### Changed
|
| 43 |
+
- What is different now, and what the reader must do about it. (#131)
|
| 44 |
+
|
| 45 |
+
### Fixed
|
| 46 |
+
- The symptom the user experienced, not the internal cause. (#134)
|
| 47 |
+
|
| 48 |
+
### Security
|
| 49 |
+
- Disclosed issue and its severity. (#136)
|
| 50 |
+
|
| 51 |
+
### Breaking
|
| 52 |
+
- The change, the migration step, and the deadline. (#139)
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
Omit empty sections. Always link the PR number. Order sections Breaking β Security β Added β Changed β Fixed when a breaking change is present.
|
| 56 |
+
|
| 57 |
+
## Writing rules
|
| 58 |
+
|
| 59 |
+
- Lead with the user-visible outcome. "Markets now settle in under 4 seconds" beats "Refactored settlement queue."
|
| 60 |
+
- One line per change. If a change needs two lines, it needs its own subsection.
|
| 61 |
+
- Specific numbers over adjectives. "3.1s β 0.4s median" not "significantly faster."
|
| 62 |
+
- Active voice, present tense.
|
| 63 |
+
- No filler. Banned: leverage, synergy, ecosystem play, game-changing.
|
| 64 |
+
- Internal-only refactors with zero user-visible effect go in a collapsed "Internal" section or are omitted entirely.
|
| 65 |
+
|
| 66 |
+
## MAD Gambit constraint
|
| 67 |
+
|
| 68 |
+
If the release touches anything user- or investor-facing, canonical numbers are frozen: platform fee 1.88%, community profit share 28.8%, creator revenue share 40%, seed raise $1β2M at $12M pre-money. Never restate them with different values, and never round the fee. Platform name is "MAD Gambit"; the card game line is "MADHAT's Gambit".
|
| 69 |
+
|
| 70 |
+
## Publishing
|
| 71 |
+
|
| 72 |
+
1. Update `CHANGELOG.md` β prepend the new section, keep the Keep-a-Changelog format if the file already uses it, preserve the existing link-reference block at the bottom.
|
| 73 |
+
2. Commit on a `chore/release-vX.Y.Z` branch (see `github-repo-ops` for the write sequence).
|
| 74 |
+
3. Create the tag and GitHub Release with the same body. Mark it prerelease when the version has a `-rc`/`-beta` suffix.
|
| 75 |
+
4. Return the release URL.
|
| 76 |
+
|
| 77 |
+
Do not publish a release until the user confirms the version number and the notes. Draft first.
|