Skip to content

Commit

Permalink
Merge pull request #205 from chromaui/steven/docs-clarified
Browse files Browse the repository at this point in the history
Changeset docs clarified
  • Loading branch information
skitterm authored Sep 26, 2024
2 parents c0a29bd + 34f5677 commit 81fa588
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,14 @@ If you wish to run the site-under-tests's server separately (e.g. to debug a spe

Versioning and releasing is done using [changesets](https://github.com/changesets/changesets/blob/main/docs/intro-to-using-changesets.md).

If a change made in a PR requires any of the integration packages to be published, you must add a changeset to your branch specifying which packages should be published, what semver version they should be bumped to, and the reason for the change.
If a change made in a PR requires any of the integration packages to be published, you must add a changeset to your branch specifying which packages should be published, what version they should be bumped to (we use [Semantic Versioning](https://semver.org/)), and the reason for the change.

This is done by running `yarn changeset`, which will guide you through all of the above.

Commit the resulting changeset file with your other changes and push it up. This can happen at any time in the lifecycle of the branch.

After your PR is merged, if you included a changeset, the repo will auto-create a "Version Packages" PR that, when merged, will publish the new package versions to NPM. You can self-review and self-merge this PR.

#### Which packages do I publish?

2 guidelines for code changes that warrant publishing to NPM:
Expand Down

0 comments on commit 81fa588

Please sign in to comment.