diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9d33822b1daeea1e49cce48f1aa378a13aab06e..6ad9d92830280cfc5c41270241f50cc87582f2d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,7 +79,17 @@ That should start a webserver which will serve the docs on https://localhost:300 Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again. -## Publishing +## Changeset + +We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new changeset, run: + +``` +pnpm changeset +``` + +Please send a descriptive changeset for each PR. + +## Publishing (maintainers only) To publish a new version of the library, first create a new version: