chore: update release instructions

graphql · Dec 3, 2024 · 5e851ce · 5e851ce
1 parent 35729a6
commit 5e851ce
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 17 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,6 +20,12 @@ We actively welcome your pull requests for documentation and code.
 7. Run `yarn changeset` and describe the change you're proposing. Commit the file it creates in `.changeset` to the repo. [You can read more about changeset here.](https://github.com/changesets/changesets)
 8. Open a Pull Request so we can review and incorporate your change.
 
+## Releases
+
+To release a new version:
+1. Run `yarn changeset version` to bump the version of the package.
+2. Run `yarn release` this will create a new release on GitHub and publish the package to NPM. 
+
 ## Issues
 
 We use GitHub issues to track public bugs. Please ensure your description is