Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
- Node.js:
>=16.15.0
- Yarn:
>=1.21.1
To install all dependencies and build all packages run the following commands from the root of the project.
yarn
yarn build
You are ready to go!
All commit messages should meet the conventional commit format. The easiest way is to use yarn cm
command which launches commit message wizard.
You don't need to worry about formatting your code. It is automatically reformatted using prettier
on every commit using Git hooks.
We use ESLint and Typescript ESLint for linting and checking code for errors.
All modern editors should automatically pick up configuration and show errors and warnings while you type.
# at the monorepo root
yarn lint
# at the monorepo root
yarn tsc
We use vitest and Testing Library for writing unit tests.
yarn test
yarn test:ci