# Release notes [#release-notes]

Use this page when you need to prepare reader-facing release notes from the
repository changelog and applied package changelogs.

## Source order [#source-order]

Use sources in this order:

1. Applied package changelogs after `bun run version-repo`.
2. The repository [`CHANGELOG.md`](https://github.com/crcorbett/taxkit/blob/a151e51e8a30247526fa93412df046955846eca4/CHANGELOG.md).
3. Pending `.changeset/*.md` files only before a release is applied.
4. 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 [#release-note-shape]

```md
# 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 [#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 --verbose` before handoff.

## Related pages [#related-pages]

* [Changelog](/reference/changelog)
* [Versioning](/reference/versioning)
* [PR evidence checklist](/contributing/pr-evidence-checklist)