Skip to content

Commit

Permalink
Add note for where to commit a changeset
Browse files Browse the repository at this point in the history
  • Loading branch information
ashygee committed Jan 28, 2022
1 parent d93a034 commit 4be66b6
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 4be66b6

Please sign in to comment.