Changeset quality rubric
Every user-visible change should have a clear changeset so maintainers can produce accurate release notes.
Required content
- What changed in plain language (not only a PR title).
- Who is affected (app developers, design-system consumers, Storybook readers, etc.).
- How to adopt the change when it is not obvious (new prop, renamed export, new CSS dependency).
Breaking changes
When "@radui/ui": major is used in a changeset:
- Include an explicit marker such as
BREAKING:or the phrase Breaking change in the changeset body. - Describe before / after usage or point to a migration section in docs.
The repository validates this rule in CI for major bumps (see scripts/validate-changesets.mjs).
Examples
Patch / minor (good)
Major (good)
Major (needs improvement)
The last example will fail CI until it documents the breaking behavior.