kylefang/create-react-app
1
0
Fork 0
mirror of https://github.com/zhigang1992/create-react-app.git synced 2026-01-12 22:46:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Contributing instructions step two (#160)

Browse Source 
* Move setup instructions to CONTRIBUTING.md

* Reword setup instructions slightly
This commit is contained in:
Max Stoiber
2016-07-24 22:26:45 +02:00
committed by Dan Abramov
parent d7ded9e33e
commit d3359507cf
2 changed files with 16 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@@ -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
README.md
View File

@@ -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