You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-4Lines changed: 10 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -22,12 +22,14 @@ yarn && yarn bootstrap
22
22
yarn build && yarn test
23
23
```
24
24
25
+
Note that all work is done against the `next` branch, we only merge to `master` when doing a release.
26
+
25
27
### Working with Storybook
26
28
27
29
We use Storybook as a development environment, particularly for the DevTools. Spin it up using:
28
30
29
31
```sh
30
-
yarn storybook
32
+
yarn start:storybook
31
33
```
32
34
33
35
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
61
63
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.
62
64
63
65
```sh
64
-
yarn test --watch
66
+
yarn test:watch
65
67
```
66
68
67
69
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
72
74
yarn test:compat
73
75
```
74
76
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.
76
78
77
79
### Working with the examples
78
80
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