Skip to content

Commit d335950

Browse files
mxstbrgaearon
authored andcommitted
Contributing instructions step two (facebook#160)
* Move setup instructions to CONTRIBUTING.md * Reword setup instructions slightly
1 parent d7ded9e commit d335950

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

Diff for: CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ Please **ask first** is somebody else is already working on this or the core dev
2222

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

25+
## Setting up a local copy of the repository
2526

27+
1. Clone the repo with `git clone https://github.com/facebookincubator/create-react-app`
28+
29+
2. Run `npm install` in the root `create-react-app` folder **and** the `create-react-app/global-cli` folder
30+
31+
Once it is done, you can modify any file locally and run `npm start` or `npm run build` just like in a generated project.
32+
33+
If you want to try out the end-to-end flow with the global CLI, you can do this too:
34+
35+
```
36+
npm run create-react-app my-app
37+
cd my-app
38+
```
39+
40+
and then run `npm start` or `npm run build`.
2641

2742
*Many thanks to [h5bp](https://github.com/h5bp/html5-boilerplate/blob/master/CONTRIBUTING.md) for the inspiration with this contributing guide*

Diff for: README.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -146,17 +146,7 @@ All of them are transient dependencies of the provided npm package.
146146

147147
## Contributing
148148

149-
Clone the repo and run `npm install` in the root and the `global-cli` folder.
150-
151-
Once it is done, you can modify any file locally and run `npm start` or `npm run build` just like in a generated project.
152-
If you want to try out the end-to-end flow with the global CLI, you can do this too:
153-
154-
```
155-
npm run create-react-app my-app
156-
cd my-app
157-
```
158-
159-
and then run `npm start` or `npm run build`.
149+
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.
160150

161151
## Acknowledgements
162152

0 commit comments

Comments
 (0)