Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 2.77 KB
Raw

Getting started

Storybook is developed against a specific node version. We recommend using Volta as it will automatically install the correct node and yarn version when you first use the repo. If you chose not to use Volta please ensure you you have node version 16 installed (suggestion: v16.5)

  • Ensure if you are using Windows to use the Windows Subsystem for Linux (WSL).
  • Run yarn start in the root directory to run a basic test Storybook "sandbox".

The yarn start script will generate a React Vite TypeScript sandbox with a set of test stories inside it, as well as taking all steps required to get it running (building the various packages we need etc). There is no need to run yarn or yarn install as yarn start will do this for you.

Issues

If you run yarn start and encounter the following error, try rerunning yarn start a second time:

>  NX   ENOENT: no such file or directory, open 'storybook/code/node_modules/nx/package.json'

Forked repos

If you have forked the repository, you should disable Github Actions for your repo as many of them (e.g. pushing to sandbox) will fail without proper authorization. In your Github repo, go to Settings > Actions > General > set the Actions Permissions to Disable actions.

Running against different sandbox templates

You can also pick a specific template to use as your sandbox by running yarn task, which will prompt you to make further choices about which template you want and which task you want to run.

Making code changes

If you want to make code changes to Storybook packages while running a sandbox, you'll need to do the following:

  1. In a second terminal run yarn build --watch <package-1> <package-2> in the code/ directory. The package names is the bit after the @storybook/ in the published package. For instance, to build the @storybook/react @storybook/core-server @storybook/api @storybook/addon-docs packages at the same time in watch mode:
cd code
yarn build --watch react core-server api addon-docs

  1. If you are running the sandbox in "linked" mode (the default), you should see the changes reflected on a refresh (you may need to restart it if changing server packages)

  2. If you are running the sandbox in "unlinked" mode you'll need to re-run the sandbox from the publish step to see the changes:

yarn task --task dev --template <your template> --start-from=publish

Contributing to Storybook

For further advice on how to contribute, please refer to our NEW contributing guide on the Storybook website.