changelog

Installation
SKILL.md

Changelog

Every user-facing PR is recorded once in ## Unreleased of CHANGELOG.md. Add the entry right after gh pr create, on the PR branch, so it lands with the squash merge. scripts/release.sh turns Unreleased into the version heading on stable releases only (betas skip it).

1. New entry, extend, or skip

"Shipped" means in the latest stable release: git describe --tags --abbrev=0 --exclude '*-*' origin/v3 (e.g. v3.11.18). main is the unreleased v4; its betas don't count — a PR already published in a v4.0.0-beta.* is still unreleased, and so is any bug it introduced.

  • Extend an existing Unreleased entry when the PR follows up on it: a fix or polish for an unreleased feature, a second PR of the same change, or another update to the same skill, guide, or example upgrade. Append the PR link (and any new contributors) and reword only if the behavior described changes. E.g. #911 + #919 + #925 (dimColor), #904 + #923 (e2e skill), #799 + #848 + #877 (truesheet-usage skill).
  • Skip a fix for a bug that never shipped — the code only exists in Unreleased (git show <tag>:<path> fails) or the regression came from an Unreleased PR, including one already out in a beta — unless it changes what an entry says, or the fix belongs to that PR's feature (extend instead). E.g. #907, #908, and #922 (TrueSheetOverlay is v4-only). Also skip changes nobody using or contributing to the library would notice: small docs notes, CI, tests, example-only build fixes.
  • New entry otherwise.

2. Section and platform

Installs
1
GitHub Stars
2.1K
First Seen
1 day ago