development.md

This repository is a monorepo and makes use of Turborepo and PNPM workspaces.

Set up

Before you begin, make sure you have the following set up on your local machine.

• Install NodeJS v16.x (LTS)
• Install PNPM

All commands below should be run at the root level of the cloned repository.

Install package dependencies

pnpm install

Build

You can build all packages using the following command:

pnpm build

Or you can run build for the individual packages using the following command:

pnpm build:[dirname]

For react it would be

pnpm build:react

Local development and testing

Once built, you can run all the packages and examples in development mode using the following command:

pnpm dev

After making and building your changes, make sure that the examples continue working and, if needed, update the relevant examples to test changes or added functionality.

Preparing a release

NOTE: Do not touch the version number of any of the packages. These are automatically updated in CI via changeset!

---

Once you made your changes, built and tested them, you will need to generate a changelog entry via running:

pnpm changeset

Step through the steps, select the packages that you've made changes to and indicate what kind of release this is.

Changeset will generate a temporary file (see example). Make sure to commit this file to your PR as this is used in CI to generate the release.

Once your PR is merged, CI will generate a PR (see example) with the changelog entries, increment the version numbers accordingly, and remove the temporary changeset files. Upon merging this PR, CI will issue the new release to npm. 🥳