Skip to content

updated contribute.md to run examples #110

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

Merged
merged 2 commits into from
Sep 14, 2019
Merged

updated contribute.md to run examples #110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f34ea2
updated contribute to run examples
Sep 10, 2019
f496a55
updated examples md
Sep 10, 2019
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
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ To start working on React Async, clone the repo and bootstrap the project:
```sh
git clone https://github.com/async-library/react-async.git
cd react-async
yarn && yarn bootstrap
yarn && yarn build:packages
yarn bootstrap
yarn build && yarn test
```

Expand Down Expand Up @@ -80,6 +81,12 @@ This runs all tests using various versions of `react` and `react-dom`, to check

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`.

To run sample examples on your local environments

```sh
yarn start:examples
```

### Resolving issues

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.