Contributing
Want to contribute but got stuck?
Please reach out on Discord
Prerequisites
To install the development dependencies, you will at least need Node 8 installed.
Installation
We use Yarn as our package manager. It will install all dev dependencies and the dependencies in the actual packages.
yarn
Building
For building all of the packages run:
yarn build
Lint & Formatting & Typechecking
To lint, format, and type check the project run the following commands:
yarn check:lint
yarn format
yarn check:ts
Run tests
Using karma (real browsers will get launched).
Notice: When you change the source files of packages, you will need to rebuild the project.
yarn test
IDEs
If you are using VS Code, you'll need to do 2 things to get Flow type support:
- Install the Flow Language Support extension.
- If necessary, update your local settings to disable JS file validation:
// <PROJECT_ROOT>/.vscode/settings.json
{
"javascript.validate.enable": false
}