From d3359507cf73ef186da90caf372f249981c8cdf7 Mon Sep 17 00:00:00 2001 From: Max Stoiber Date: Sun, 24 Jul 2016 22:26:45 +0200 Subject: [PATCH] Contributing instructions step two (#160) * Move setup instructions to CONTRIBUTING.md * Reword setup instructions slightly --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 12 +----------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5b4e4f1832..feb886b3d61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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* diff --git a/README.md b/README.md index e1b02e05f7d..70dbf1a635d 100644 --- a/README.md +++ b/README.md @@ -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