Skip to content

Commit

Permalink
Merge branch 'master' into linting
Browse files Browse the repository at this point in the history
  • Loading branch information
ndelangen committed May 9, 2017
2 parents 96830d0 + 9e9fe66 commit 695926e
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 25 deletions.
5 changes: 4 additions & 1 deletion .jestrc → .jestrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
"\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/__mocks__/fileMock.js",
"\\.(css|scss)$": "<rootDir>/__mocks__/styleMock.js"
},
"roots": ["packages"],
"projects": [
"<rootDir>/packages/*",
"<rootDir>/examples/*"
],
"collectCoverage": false,
"collectCoverageFrom": [
"packages/**/*.{js,jsx}",
Expand Down
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,5 @@ script:
- npm run lint
- npm run test -- --coverage
- npm run coverage
- npm run test-examples
git:
depth: 1
53 changes: 41 additions & 12 deletions CONTRIBUTING.md
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
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 All @@ -47,10 +76,10 @@ If you follow that process, you can then link to the github repository in the is

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

* Fix typos and add more documentation.
* Fix typos and add more [documentation](https://github.com/storybooks/storybook/labels/needs%20docs).
* Try to fix some [bugs](https://github.com/storybooks/storybook/labels/bug).
* Work on [enhancements](https://github.com/storybooks/storybook/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) and new [features](https://github.com/storybooks/storybook/issues?q=is%3Aissue+is%3Aopen+label%3Afeature).
* Add more tests (specially for the UI).
* Work on [API](https://github.com/storybooks/storybook/labels/enhancement%3A%20api), [Addons](https://github.com/storybooks/storybook/labels/enhancement%3A%20addons), [UI](https://github.com/storybooks/storybook/labels/enhancement%3A%20ui) or [Webpack](https://github.com/storybooks/storybook/labels/enhancement%3A%20webpack) use enhancements and new [features](https://github.com/storybooks/storybook/labels/feature%20request).
* Add more [tests](https://codecov.io/gh/storybooks/storybook/tree/master/packages) (specially for the [UI](https://codecov.io/gh/storybooks/storybook/tree/master/packages/storybook-ui/src)).

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.

Expand Down
2 changes: 1 addition & 1 deletion examples/cra-storybook/src/stories/Welcome.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default class Welcome extends React.Component {
{' '}
<a
style={styles.link}
href="https://getstorybook.io/docs/basics/writing-stories"
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
target="_blank"
>
Writing Stories
Expand Down
2 changes: 1 addition & 1 deletion examples/test-cra/src/stories/Welcome.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default class Welcome extends React.Component {
{' '}
<a
style={styles.link}
href="https://getstorybook.io/docs/basics/writing-stories"
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
target="_blank"
>
Writing Stories
Expand Down
9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
"eslint": "^3.19.0",
"eslint-config-airbnb-base": "^11.1.3",
"eslint-plugin-import": "^2.2.0",
"eslint-plugin-jest": "^19.0.1",
"eslint-plugin-jest": "^20.0.0",
"eslint-plugin-prettier": "^2.0.1",
"jest": "^19.0.2",
"jest-enzyme": "^3.0.1",
"jest": "^20.0.0",
"jest-enzyme": "^3.1.0",
"lerna": "2.0.0-rc.4",
"prettier": "^1.1.0",
"react": "^15.5.4",
Expand All @@ -29,9 +29,8 @@
"scripts": {
"bootstrap": "lerna bootstrap",
"lint": "eslint .",
"test": "jest --config ./.jestrc",
"test": "jest --config ./.jestrc.json",
"test:watch": "npm test -- --watch",
"test-examples": "CI=true lerna run test",
"coverage": "codecov"
}
}
1 change: 0 additions & 1 deletion packages/addon-knobs/src/components/PropField.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ const stylesheet = {
width: 80,
fontSize: 10,
color: 'rgb(68, 68, 68)',
textTransform: 'uppercase',
fontWeight: 600,
},
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default class Welcome extends React.Component {
{' '}
<a
style={styles.link}
href="https://getstorybook.io/docs/basics/writing-stories"
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
target="_blank"
>
Writing Stories
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// you can use this file to add your custom webpack plugins, loaders and anything you like.
// This is just the basic way to add addional webpack configurations.
// For more information refer the docs: https://getstorybook.io/docs/configurations/custom-webpack-config
// For more information refer the docs: https://storybooks.js.org/docs/react-storybook/configurations/custom-webpack-config

// IMPORTANT
// When you add this file, we won't add the default configurations which is similar
Expand Down
2 changes: 1 addition & 1 deletion packages/react-storybook/demo/src/stories/Welcome.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default class Welcome extends React.Component {
{' '}
<a
style={styles.link}
href="https://getstorybook.io/docs/basics/writing-stories"
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
target="_blank"
>
Writing Stories
Expand Down

0 comments on commit 695926e

Please sign in to comment.