Contributing to React Storybook

We welcome you help to make React Storybook better. This document will help to streamline the contributing process and save everyone's precious time.

Issues

No software is bug free. So, if you got an issue, follow these steps:

Search the issue list for current and old issues.
If non of that is helping, create an issue with with following information:
- Clear title (make is shorter if possible).
- Describe the issue in clear language.
- Share error logs, screenshots and etc.
- To speed up the issue fixing process, send us a sample repo with the issue you faced.

We welcome your contributions. There are many ways you can help us. This is few of those ways:

Before you submit a new PR, make you to run npm test. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.

If you want to work on a UI feature, refer to the Storybook UI project.

This project written in ES2016+ syntax so, we need to transpile it before use. So run the following command:

npm run dev

This will watch files and transpile.

First of all link this repo with:

npm link

In order to test features you add, you may need to link the local copy of this repo. For that we need a sample project. Let's create it.

npm i -g create-react-app getstorybook
create-react-app my-demo-app
cd my-demo-app
getstorybook

It's pretty important to create a very simple sample project like above. Otherwise some of the functionality won't work because of likning.

Then link storybook inside the sample project with:

npm link @kadira/storybook

After you've done any change, you need to run the npm run storybook command everytime to see those changes.