Updated Changesets (markdown)

Tyler Butler 2023-04-19 09:16:03 -07:00
Родитель 73b4fb396e
Коммит 876f5e1fd7
1 изменённых файлов: 5 добавлений и 1 удалений

@ -1,6 +1,6 @@
# Changesets
_Last updated April 13 2023_
_Last updated April 19 2023_
We use a modified version of the [changesets][] workflow to track changes that we want to communicate to customers or partners.
@ -50,6 +50,10 @@ To add a changeset, run `pnpm changeset` from the root of the repo. You will be
To manually add a changeset, add a randomly named markdown file to the `.changeset` folder in the root of the repo. Make sure to include the metadata about what packages are affected!
### Adding an empty changeset
You can add an empty changeset using the command `pnpm changeset --empty`. Make sure to add details about the change, including the metadata about what packages are affected!
### How do I know what packages to include in the changeset?
Each package in the changeset will have a changelog entry with the contents of the changeset. In other words, if you list a package in a changeset, you're saying that the contents of the changeset are relevant to that package. You do not need to include _every_ package that was changed in a given PR. For example, if you deprecate a class in packageA and replace the use of the deprecated class in packageB, then packageB probably shouldn't be included in the changeset, while packageA should be.