Treat a changeset as the release note for the complete PR, not as a log of work
performed along the way. Finalize it after the current implementation scope and
focused validation are complete.
Workflow
- Inspect the complete diff from the merge base, including changeset files
already introduced by the PR, and identify directly affected published
packages.
- Classify impact across source types, runtime behavior, entrypoints, required
services, lifecycle, and persisted or wire data.
- Perform the breaking audit below.
- Record a reason no changeset is required, or update the PR's existing
changeset. Create one only when the PR does not have one. When required, read
authoring.md.
- Validate package names, frontmatter, bump policy, and a one-sentence
consumer-facing description, longer only for breaks or required migration.
Do not include unrelated worktree changes.
PR-level consolidation
The default is one changeset file per PR. One file can name several packages and
summarize several related fixes or additions. Successive prompts, commits, and
subtasks within the same PR update that file. If implementation resumes after a
changeset was drafted, revise it during the next finalization pass.
Use separate files only when a maintainer requests the split or the PR contains
independent changes that need separate release notes.
Requirement
Create a changeset for observable runtime behavior changes, including bug
fixes; exported value or public type changes; entrypoint or export-map changes;
changes to required services, errors, ownership, defaults, or lifecycle; and
persisted, serialization, protocol, or wire-format changes.
Tests-only changes, behavior-preserving internal refactors, documentation or
JSDoc maintenance, and unpublished tooling normally do not need one. When
unclear, inspect exports and consumer-visible declarations rather than inferring
from source location.
Breaking Audit
A change is breaking when valid existing consumer code, configuration, or data
must change to keep compiling or behaving according to the previous contract.
Audit every surface:
- Names and locations: exports, entrypoints, compatibility exports, and
module paths.
- Call compatibility: parameters, accepted inputs, overload resolution,
generic parameters, and defaults.
- Result compatibility: return and error types, output narrowing, members,
inference, and required services.
- Runtime contracts: defaults, failures, interruption, concurrency,
ordering, resource lifetime, acquisition, cleanup, and mutation.
- Data compatibility: persisted schemas, encodings, database layouts,
protocols, and wire formats.
Additive exports, optional parameters, and behavior-preserving implementations
are normally non-breaking. A fix restoring the documented contract is normally
non-breaking but still needs a changeset when its operational impact is
consumer-visible. Verify representative existing calls when overload ordering,
structural assignability, or inference makes compatibility uncertain. API diff
output is mechanical evidence, not a semantic-version decision.
The task is complete when every affected contract and published package is
accounted for and either the no-changeset decision is explicit or the PR has one
consolidated, valid changeset by default. Its release note is one sentence of
consumer impact, plus migration steps for every break, with no implementation
detail.
1---2name: changesets3description: Concise PR finalization changesets. Use when implementation scope is complete and focused validation has finished to classify release impact, consolidate the PR's existing changeset, or write its consumer release note.4metadata:5 source: https://skillmd.com/skills/tuyv/changesets6---78Treat a changeset as the release note for the complete PR, not as a log of work9performed along the way. Finalize it after the current implementation scope and10focused validation are complete.1112## Workflow13141. Inspect the complete diff from the merge base, including changeset files15 already introduced by the PR, and identify directly affected published16 packages.172. Classify impact across source types, runtime behavior, entrypoints, required18 services, lifecycle, and persisted or wire data.193. Perform the breaking audit below.204. Record a reason no changeset is required, or update the PR's existing21 changeset. Create one only when the PR does not have one. When required, read22 [authoring.md](authoring.md).235. Validate package names, frontmatter, bump policy, and a one-sentence24 consumer-facing description, longer only for breaks or required migration.2526Do not include unrelated worktree changes.2728## PR-level consolidation2930The default is one changeset file per PR. One file can name several packages and31summarize several related fixes or additions. Successive prompts, commits, and32subtasks within the same PR update that file. If implementation resumes after a33changeset was drafted, revise it during the next finalization pass.3435Use separate files only when a maintainer requests the split or the PR contains36independent changes that need separate release notes.3738## Requirement3940Create a changeset for observable runtime behavior changes, including bug41fixes; exported value or public type changes; entrypoint or export-map changes;42changes to required services, errors, ownership, defaults, or lifecycle; and43persisted, serialization, protocol, or wire-format changes.4445Tests-only changes, behavior-preserving internal refactors, documentation or46JSDoc maintenance, and unpublished tooling normally do not need one. When47unclear, inspect exports and consumer-visible declarations rather than inferring48from source location.4950## Breaking Audit5152A change is breaking when valid existing consumer code, configuration, or data53must change to keep compiling or behaving according to the previous contract.54Audit every surface:5556- **Names and locations:** exports, entrypoints, compatibility exports, and57 module paths.58- **Call compatibility:** parameters, accepted inputs, overload resolution,59 generic parameters, and defaults.60- **Result compatibility:** return and error types, output narrowing, members,61 inference, and required services.62- **Runtime contracts:** defaults, failures, interruption, concurrency,63 ordering, resource lifetime, acquisition, cleanup, and mutation.64- **Data compatibility:** persisted schemas, encodings, database layouts,65 protocols, and wire formats.6667Additive exports, optional parameters, and behavior-preserving implementations68are normally non-breaking. A fix restoring the documented contract is normally69non-breaking but still needs a changeset when its operational impact is70consumer-visible. Verify representative existing calls when overload ordering,71structural assignability, or inference makes compatibility uncertain. API diff72output is mechanical evidence, not a semantic-version decision.7374The task is complete when every affected contract and published package is75accounted for and either the no-changeset decision is explicit or the PR has one76consolidated, valid changeset by default. Its release note is one sentence of77consumer impact, plus migration steps for every break, with no implementation78detail.