-
Notifications
You must be signed in to change notification settings - Fork 14
Changelog & Labels
This project uses the github-changelog-generator. We automatically generate our changelog each release based off the title of the PR + the labels used.
We use the following labels to generate the section headings within the changelog: enhancement, bug, improvement, new kit, deprecated, & breaking. Do not use more than one of the following labels on a PR.
This is used when your PR contains new features, new props, or new design variants. These are backward compatible. Typescript conversions also fall under this category.
Fixes to issues and bugs discovered in Playbook.
This is used when your PR contains library upgrades or doc/site improvements. Generally will not affect the kit in any way. These are backward compatible.
Use this when adding a new kit to Playbook
Use this label when you have removed or plan to remove kits or props. These are usually NOT backward compatible.
This label indicates that a breaking change was introduced. Use this when your update is NOT backward compatible. Any deletion or rename of a prop is a breaking change unless it’s made backward compatible. Changes to prop types are also breaking. Changes to enum values can also be breaking depending on the use cases. Another clue for breaking changes are updates to tests. If a PR includes a breaking change we need to treat it with considerable scrutiny. If you are unsure if your PR is a breaking change or not, please reach out to the Playbook team for feedback.