CONTRIBUTING.md

How to contribute

Requirements

• Node.js (version 18 or higher)

Local development

1. Link local modules

npm run link

2. Build packages

• Build dist (with types)

npm run build

• Build & watch (js only + hot reloading)

npm run build:watch

3. Go to pages folder and run web dev server

• Component API Viewer
  
• Apps Playground
  

npm run dev

For more details visit individual package folder.

Releasing

1. Run changeset and specify new package version & change summary

Note: If releasing multiple packages, you can run changeset just once if u wish to share changelog and version type, or for each package separately (preferred).

npm run changeset

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version for breaking change (incompatible API changes)
• MINOR version for new feature(s)
• PATCH version for bug fixes

2. Bump version, lockfile & create commit message

npm run changeset:version

3. Build, publish NPM packages & push refs to origin

npm run release