From 4be66b6c242701d3b6baaa39815d8c75b2f37eb6 Mon Sep 17 00:00:00 2001 From: Ash Guillaume <10384315+ashygee@users.noreply.github.com> Date: Fri, 28 Jan 2022 10:58:43 -0500 Subject: [PATCH] Add note for where to commit a changeset --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6ff22f38..b1b0d6df8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,6 +99,8 @@ Releases are managed by 🦋 [Changesets](https://github.com/atlassian/changeset We have the [changeset-bot comment on new pull requests](https://github.com/changesets/bot#readme) asking contributors or maintainers to add a changeset file, which will become the markdown supported changelog entry for the change. +When creating the changeset always commit into the working branch (pull request branch), not `main`. + When a pull request is approved merge it into the `main` branch. The changeset action will then create a Release pull request that includes this new pull request. Once maintainers have agreed and are satisifed with the release. Merge the Release pull request. Changesets will then publish a new GitHub release to the repository with the changelog and new version number. A second action will be triggered by this release and publish the new versions to npm and rubygems.