gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update contributing doc to better handle first run dpendency requirements (#1645)

Browse Source 
The command `yarn start` is dependent on the `npm-run-all` package, therefore we can't recommend this as the first command someone runs after they just clone the repository in case they don't have it globally installed. Trying to `yarn start` without this package gets:

```
/bin/sh: run-s: command not found
error Command failed with exit code 127.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
```

Therefore, on first setup it is recommended to run `yarn bootstrap` as the first command.
This commit is contained in:
Mitchell Cash
2018-08-23 03:02:53 +10:00
committed by Jessica Parsons
parent 82a6256458
commit a4ba66e1a6
3 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -9,9 +9,20 @@ For details on contributing to documentation, see [Website Directory Readme](htt
> Install yarn on your system: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
### Install dependencies
> Only required on the first run, subsequent runs can use `yarn start` to both
bootstrap and run the development server.
```sh
$ git clone https://github.com/netlify/netlify-cms
$ cd netlify-cms
$ yarn bootstrap
```
### Run locally
```sh
$ yarn start
```