Skip to content

Commit

Permalink
docs: update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
atanasster committed Jun 20, 2020
1 parent 21b2892 commit ff79712
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

0 comments on commit ff79712

Please sign in to comment.