From 875d3d93d6b6b30a746743df1e13c2502da368be Mon Sep 17 00:00:00 2001 From: Tanner Linsley Date: Sun, 14 May 2017 01:18:35 -0600 Subject: [PATCH] Update Contributing --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fad1b28..ee2f2f5 100644 --- a/README.md +++ b/README.md @@ -891,19 +891,18 @@ To suggest a feature, create an issue if it does not already exist. If you would like to help develop a suggested feature follow these steps: - Fork this repo -- `$ yarn` -- `$ yarn run storybook` +- Install dependencies with `$ yarn` +- Auto-build files as you edit with `$ yarn run watch` - Implement your changes to files in the `src/` directory -- View changes as you code via our React Storybook `localhost:8000` -- Make changes to stories in `/stories`, or create a new one if needed +- Run the React Story locally with `$ yarn run docs` +- View changes as you edit `docs/src`, - Submit PR for review #### Scripts -- `$ yarn run storybook` Runs the storybook server +- `$ yarn run watch` Watches files and builds via babel +- `$ yarn run docs` Runs the storybook server - `$ yarn run test` Runs the test suite -- `$ yarn run prepublish` Builds the distributable bundle -- `$ yarn run docs` Builds the website/docs from the storybook for github pages ## Used By