From c05a65e0606344a82abd6b749920f0ce7ebbe77d Mon Sep 17 00:00:00 2001 From: Jake Bailey <5341706+jakebailey@users.noreply.github.com> Date: Thu, 6 Jun 2024 09:01:14 -0700 Subject: [PATCH] Clarify changesets in README (#3146) --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e08a7debe1ba..afd790324ad9 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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