Merge pull request #188 from chromaui/steven/clarify-versioning

Docs: Package versioning clarification
chromaui · Aug 2, 2024 · b7b98b4 · b7b98b4
2 parents 70aac88 + d2177ca
commit b7b98b4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -53,6 +53,13 @@ This is done by running `yarn changeset`, which will guide you through all of th
 
 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.
 
+#### Which packages do I publish?
+
+2 guidelines for code changes that warrant publishing to NPM:
+
+1. Publish every package where code changes occur. Example: if you touch code in the `shared` directory, you'll want to include `@chromatic-com/shared-e2e` in the list of packages to be published, even though that package is private.
+1. Publish every package that the changed code affects. If you are only changing code in the `@chromatic-com/shared-e2e` package, you will also need to explicitly include the `chromatic-com/playwright` and `chromatic-com/cypress` packages as packages to publish.
+
 ### Canary Releases
 
 The changeset file on a branch will be used to cut canary releases of the changed packages in the PR.