Skip to content

Commit

Permalink
Clarify changesets in README (#3146)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jakebailey
jakebailey authored Jun 6, 2024
1 parent fb87ad9 commit c05a65e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ If you want to know _in-depth_ how this website works, there is an [hour long vi

This repo uses `pnpm` + `changesets` to manage package version bumps and releases.

CI will fail if a PR is missing a changeset. To add a changeset, run `pnpm changeset`, then follow along with the CLI.
CI will fail if a PR modifies a public package but is missing a changeset. To add a changeset, run `pnpm changeset`, then follow along with the CLI.

```console
$ pnpm changeset
Expand All @@ -70,7 +70,8 @@ $ pnpm changeset

New files will be created in `.changeset` and must be committed.

If you are making a change that does not affect published code, you can create an empty changeset for your PR with `pnpm changeset --empty`.
PRs which don't modify public packages (e.g. website content updates) do not require changesets.
If you are making a change to a published package but are not affecting published code, you can create an empty changeset for your PR with `pnpm changeset --empty`.

# Website Packages

Expand Down

0 comments on commit c05a65e

Please sign in to comment.