CONTRIBUTING.md

Contributing

• The packages are linked with NPM workspaces and released with changesets.

Getting Started

• Checkout the repo
• Install npm i
• Build the packages you need npm run build
• Run a subproject, e.g. cd packages/react-example && npm run start

Publishing

Deploys are managed with [changesets]

• Use npx changeset to add a changeset entry describing a change made.
  • Be sure to mark any packages relying on the changed package to have a patch bump. If a package does not have a changeset, it will not get a version bump.
• Run npx changeset version to preview the updates that will occur.
  • Do not commit this preview. The automatic PR will take care of this when it is time to publish.
• Once everything looks good, changes will be merged to the main branch, and an automatic PR will be created by changesets.
• Merging this automatic PR will officially update all package versions appropriately and publish the necessary packages.