Release notes
Use this page when you need to prepare reader-facing release notes from the repository changelog and applied package changelogs.
Source order
Use sources in this order:
- Applied package changelogs after
bun run version-repo. - The repository
CHANGELOG.md. - Pending
.changeset/*.mdfiles only before a release is applied. - Public docs pages when the release changes SDK, API or contribution behaviour.
Describe local changes as unreleased until you have a receipt for the exact published package or deployed API. Package manifests, source exports and local checks establish implementation; they do not establish public availability.
Release note shape
# Version 1.0.0 (unpublished)
## Changed
- Changed package names to `@taxkit/*`.
- Changed runtime configuration names to the `TAXKIT_` prefix.
## Migration notes
Update package imports and runtime configuration names. Packages remain
private and unpublished.Review checklist
- Name the affected public SDK, API, calculator or package surface.
- Explain required migration steps, if any.
- Link to the owning guide or reference page.
- Avoid downstream application details.
- Confirm
bun run changeset status --verbosebefore handoff.