Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First pass at update the contribution instructions #982

Merged
merged 4 commits into from
May 9, 2017
Merged

First pass at update the contribution instructions #982

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b59092
First pass at update the contribution instructions
May 1, 2017
472c07d
Update CONTRIBUTING.md
ndelangen May 9, 2017
8a494d3
Update CONTRIBUTING.md
ndelangen May 9, 2017
037453d
Merge branch 'master' into reproduce-against-master
ndelangen May 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 38 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,57 @@ No software is bug free. So, if you got an issue, follow these steps:
* Share error logs, screenshots and etc.
* To speed up the issue fixing process, send us a sample repo with the issue you faced:

### Testing against `master`

To test your project against the current latest version of storybook, you can clone the repository and link it with `npm`. Try following these steps:

1. Download the latest version of this project, and build it

```
git clone https://github.com/storybooks/storybook.git
cd storybook
npm install
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this moment when I npm install it only installs root dependencies. In order to install all packages, I need to run npm run bootstrap.
OS: Windows. So I can't tell is it common or only windows issue (but previosly npm install started to install everything inside packages folder)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ndelangen where are we at with fixing this problem? Should we update these instructions or will it be sorted soon?

Copy link
Member

@ndelangen ndelangen May 9, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be changed so npm run bootstrap is a required step.

I changed this because bootstrapping is not always needed when adding a root dependency for example, but it does take a huge amount of time.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added it

npm run bootstrap
```

2. Link `storybook` and any other required dependencies

```
cd packages/react-storybook
npm link

cd <your-project>
npm link @kadira/storybook

# repeat with whichever other parts of the monorepo you are using.
```

### Reproductions

The best way to help figure out an issue you are having is to produce a minimal reproduction. A good way to do that is using Create React App:
The best way to help figure out an issue you are having is to produce a minimal reproduction against the `master` branch.

A good way to do that is using the example `test-cra` app embedded in this repository:

```bash
npm install --global create-react-app getstorybook
# Download and build this repository:
git clone https://github.com/storybooks/storybook.git
cd storybook
npm install
npm run bootstrap

create-react-app reproduction
cd reproduction
getstorybook
cd examples/test-cra

# make changes to try and reproduce the problem, such as adding components + stories
npm start storybook

# see if you can see the problem, if so, commit it:
git init
git checkout "branch-describing-issue"
git add -A
git commit -m "reproduction for issue #123"

# create an new repository on github to host the reproduction, then:
git remote add origin https://github.com/<your-username>/<repo-name>
git push -u origin master
# fork the storybook repo to your account, then add the resulting remote
git remote add <your-username> https://github.com/<your-username>/storybook.git
git push -u <your-username> master
```

If you follow that process, you can then link to the github repository in the issue. See https://github.com/storybooks/storybook/issues/708#issuecomment-290589886 for an example.
Expand Down