Skip to content

Commit

Permalink
Contributing instructions step two (facebook#160)
Browse files Browse the repository at this point in the history
* Move setup instructions to CONTRIBUTING.md

* Reword setup instructions slightly
  • Loading branch information
mxstbr authored and gaearon committed Jul 24, 2016
1 parent d7ded9e commit d335950
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,21 @@ Please **ask first** is somebody else is already working on this or the core dev

Please also provide a **test plan**, i.e. specify how you verified what you added works.

## Setting up a local copy of the repository

1. Clone the repo with `git clone https://github.com/facebookincubator/create-react-app`

2. Run `npm install` in the root `create-react-app` folder **and** the `create-react-app/global-cli` folder

Once it is done, you can modify any file locally and run `npm start` or `npm run build` just like in a generated project.

If you want to try out the end-to-end flow with the global CLI, you can do this too:

```
npm run create-react-app my-app
cd my-app
```

and then run `npm start` or `npm run build`.

*Many thanks to [h5bp](https://github.com/h5bp/html5-boilerplate/blob/master/CONTRIBUTING.md) for the inspiration with this contributing guide*
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,17 +146,7 @@ All of them are transient dependencies of the provided npm package.

## Contributing

Clone the repo and run `npm install` in the root and the `global-cli` folder.

Once it is done, you can modify any file locally and run `npm start` or `npm run build` just like in a generated project.
If you want to try out the end-to-end flow with the global CLI, you can do this too:

```
npm run create-react-app my-app
cd my-app
```

and then run `npm start` or `npm run build`.
We'd love to have your helping hand on `create-react-app`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.

## Acknowledgements

Expand Down

0 comments on commit d335950

Please sign in to comment.