Skip to content

Commit f5dda65

Browse files
committed
Update contribution guide.
1 parent 0ef2f6c commit f5dda65

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@ yarn && yarn bootstrap
2222
yarn build && yarn test
2323
```
2424

25+
Note that all work is done against the `next` branch, we only merge to `master` when doing a release.
26+
2527
### Working with Storybook
2628

2729
We use Storybook as a development environment, particularly for the DevTools. Spin it up using:
2830

2931
```sh
30-
yarn storybook
32+
yarn start:storybook
3133
```
3234

3335
This should open up Storybook in a browser at http://localhost:6006/
@@ -61,7 +63,7 @@ This should enable auto-fix for all source files, and give linting warnings and
6163
Use the following command to test all packages in watch mode. Refer to the [Jest CLI options](https://jestjs.io/docs/en/cli#options) for details.
6264

6365
```sh
64-
yarn test --watch
66+
yarn test:watch
6567
```
6668

6769
In general, this is sufficient during development. Travis CI will apply a more rigorous set of tests.
@@ -72,8 +74,12 @@ In general, this is sufficient during development. Travis CI will apply a more r
7274
yarn test:compat
7375
```
7476

75-
This runs all tests using various versions of `react` and `react-dom`, to check for compatibility with older/newer versions of React. This is what Travis runs.
77+
This runs all tests using various versions of `react` and `react-dom`, to check for compatibility with older/newer versions of React. This is what CircleCI and Travis run.
7678

7779
### Working with the examples
7880

79-
In the `examples` folder, you will find sample React applications that use React Async in various ways with various other libraries. Please add a new example when introducing a major new feature.
81+
In the `examples` folder, you will find sample React applications that use React Async in various ways with various other libraries. Please add a new example when introducing a major new feature. Make sure to add it to `now.json` so it is automatically deployed when merged to `master`.
82+
83+
### Resolving issues
84+
85+
Sometimes your dependencies might end up in a weird state, causing random issues, especially when working with the examples. In this case it often helps to run `yarn clean -y && yarn bootstrap`. This will delete `node_modules` from all packages/examples and do a clean install.

0 commit comments

Comments
 (0)