Skip to content

Commit

Permalink
Merge branch 'master' into release/3.3
Browse files Browse the repository at this point in the history
# Conflicts:
#	.circleci/config.yml
#	CONTRIBUTING.md
#	README.md
#	addons/knobs/package.json
#	addons/storyshots/package.json
#	app/vue/package.json
#	docs/yarn.lock
#	lerna.json
#	package.json
#	scripts/hoist-internals.js
#	yarn.lock
  • Loading branch information
Hypnosphi committed Sep 30, 2017
2 parents 38df1ed + 3e9da08 commit 7e32662
Show file tree
Hide file tree
Showing 9 changed files with 1,283 additions and 1,033 deletions.
2 changes: 0 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ defaults: &defaults
working_directory: /tmp/storybook
docker:
- image: node:8
environment:
BASH_ENV: ~/.bashrc

version: 2
dependencies:
Expand Down
62 changes: 31 additions & 31 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thanks for your interest in improving Storybook! We are a community-driven proje

Please review this document to help to streamline the process and save everyone's precious time.

This repo uses yarn workspaces, so you should `[email protected]` or higher as package manager. See [installation guide](<>).
This repo uses yarn workspaces, so you should `[email protected]` or higher as package manager. See [installation guide](https://yarnpkg.com/en/docs/install).

## Issues

Expand All @@ -28,7 +28,7 @@ To test your project against the current latest version of storybook, you can cl
git clone https://github.com/storybooks/storybook.git
cd storybook
yarn install
yarn bootstrap
yarn bootstrap --core
```

The bootstrap command will ask which sections of the codebase you want to bootstrap. Unless you're going to work with ReactNative or the Documentation, you can keep the default.
Expand Down Expand Up @@ -75,42 +75,42 @@ In that case, please check the git diff before commiting to make sure it only co

If you want to test your own existing project using the github version of storybook, you need to `link` the packages you use in your project.

```sh
````sh
cd app/react
yarn link

cd <your-project>
yarn link @storybook/react

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

### Reproductions
### Reproductions

The best way to help figure out an issue you are having is to produce a minimal reproduction against the `master` branch.
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 `cra-kitchen-sink` app embedded in this repository:
A good way to do that is using the example `cra-kitchen-sink` app embedded in this repository:

```sh
# Download and build this repository:
git clone https://github.com/storybooks/storybook.git
cd storybook
yarn install
yarn bootstrap
```sh
# Download and build this repository:
git clone https://github.com/storybooks/storybook.git
cd storybook
yarn install
yarn bootstrap --core
# make changes to try and reproduce the problem, such as adding components + stories
cd examples/cra-kitchen-sink
yarn storybook
# make changes to try and reproduce the problem, such as adding components + stories
cd examples/cra-kitchen-sink
yarn storybook
# see if you can see the problem, if so, commit it:
git checkout "branch-describing-issue"
git add -A
git commit -m "reproduction for issue #123"
# see if you can see the problem, if so, commit it:
git checkout "branch-describing-issue"
git add -A
git commit -m "reproduction for issue #123"
# 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
```
# 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 Expand Up @@ -192,11 +192,11 @@ If you run into trouble here, make sure your node, npm, and **_yarn_** are on th
4. `yarn`
5. `yarn bootstrap --core`
6. `yarn test --core`
7. `yarn dev` *You must have this running for your changes to show up*
7. `yarn dev` _You must have this running for your changes to show up_
#### Bootstrapping everything
*This method is slow*
_This method is slow_
1. `yarn bootstrap --all`
2. Have a beer 🍺
Expand All @@ -210,8 +210,8 @@ Not only do these show many of the options and addons available, they are also a
#### React and Vue
1. `yarn storybook`
2. Verify that your local version works
1. `yarn storybook`
2. Verify that your local version works
### Working with your own app
Expand All @@ -228,7 +228,7 @@ Storybook is broken up into sub-projects that you can install as you need them.
**_Note:_** If you aren't seeing addons after linking storybook, you probably have a versioning issue which can be fixed by simply linking each addon you want to use.
This applies for the kitchen sink apps as well as your own projects.
*Make sure `yarn dev` is running*
_Make sure `yarn dev` is running_
##### 1. Setup storybook in your project
Expand Down Expand Up @@ -323,7 +323,7 @@ git commit -m "Changelog for vX.Y"
yarn bootstrap --reset --core
# publish and tag the release
yarn run publish -- --concurrency 1
yarn run publish --concurrency 1
# update the release page
open https://github.com/storybooks/storybook/releases
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ We welcome contributions to Storybook!

> Installs package dependencies and links packages together - using lerna
#### `yarn publish`
#### `yarn run publish`

> Push a release to git and npm
> will ask for version in interactive mode - using lerna.
Expand All @@ -109,7 +109,7 @@ We welcome contributions to Storybook!
- `yarn lint:md` - will check markdown + code samples

- `yarn lint:js --fix` - will automatically fix js
- `yarn lint:md -o` - will automatically fix markdown
- `npm run lint:md -- -o` - will automatically fix markdown

#### `yarn test`

Expand Down
1 change: 0 additions & 1 deletion addons/knobs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"scripts": {
"prepare": "node ../../scripts/prepare.js",
"publish-storybook": "bash .scripts/publish_storybook.sh",
"start": "./example/prepare.sh",
"storybook": "start-storybook -p 9010"
},
"dependencies": {
Expand Down
4 changes: 2 additions & 2 deletions app/vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"main": "dist/client/index.js",
"bin": {
"build-storybook": "./bin/build.js",
"start-storybook": "bin/index.js",
"storybook-server": "bin/index.js"
"start-storybook": "./bin/index.js",
"storybook-server": "./bin/index.js"
},
"repository": {
"type": "git",
Expand Down
Loading

0 comments on commit 7e32662

Please sign in to comment.