diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58037a4e4..91d4830af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,4 +16,17 @@ Then, run `yarn bootstrap` followed by `yarn build` To run the monorepo, run `yarn dev` in the home directory. This starts a rollup watch service to monitor for any changes in packages. -To run one of the examples, navigate to the examples folder i.e. `cd examples/storybook-6-no-docs`, and run `yarn storybook` +To run one of the examples, navigate to the examples folder i.e. `cd examples/storybook-6-no-docs`, and run `yarn start` + +## Tests + +jest: `yarn test` +lint: `yarn lint` + +## Documentation + +API documentation in the README.md files is generated automatically: `yarn docs` + +## Build all examples + +`yarn examples`