From a4ba66e1a6ce52c808d2dcbbd676592ca6fe18e6 Mon Sep 17 00:00:00 2001 From: Mitchell Cash Date: Thu, 23 Aug 2018 03:02:53 +1000 Subject: [PATCH] Update contributing doc to better handle first run dpendency requirements (#1645) 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. --- .all-contributorsrc | 10 ++++++++++ CONTRIBUTING.md | 11 +++++++++++ README.md | 4 ++-- 3 files changed, 23 insertions(+), 2 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 86cd8c9f..e2d57ff9 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -1022,6 +1022,16 @@ "contributions": [ "doc" ] + }, + { + "login": "MitchellCash", + "name": "Mitchell Cash", + "avatar_url": "https://avatars2.githubusercontent.com/u/8009243?v=4", + "profile": "https://mitchellcash.com", + "contributions": [ + "bug", + "doc" + ] } ], "repoType": "github" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75ecfc2f..8fb7e4c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 ``` diff --git a/README.md b/README.md index 9a6d9081..31472f73 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Netlify CMS -[![All Contributors](https://img.shields.io/badge/all_contributors-116-orange.svg)](#contributors) +[![All Contributors](https://img.shields.io/badge/all_contributors-117-orange.svg)](#contributors) [![Open Source Helpers](https://www.codetriage.com/netlify/netlify-cms/badges/users.svg)](https://www.codetriage.com/netlify/netlify-cms) [![](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/netlify/netlifycms) @@ -78,7 +78,7 @@ These wonderful folks are responsible for developing and maintaining Netlify CMS | [
David Ko](https://github.com/daveyko)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=daveyko "Code") | [
IΓ±aki GarcΓ­a](http://www.txorua.com)
[🎨](#design-igarbla "Design") | [
Sam](https://github.com/gazebosx3)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=gazebosx3 "Code") | [
Josh Dzielak](https://dzello.com)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=dzello "Documentation") | [
Jeremy Bise](http://thosegeeks.com)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=jeremybise "Documentation") | [
terrierscript](https://terrierscript.com)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=terrierscript "Code") | [
Christopher Geary](https://twitter.com/crgeary)
[πŸ”Œ](#plugin-crgeary "Plugin/utility libraries") | | [
Brian Macdonald](https://github.com/brianlmacdonald)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=brianlmacdonald "Code") | [
John Vandenberg](https://jayvdb.github.io/)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=jayvdb "Documentation") | [
MarkZither](https://github.com/MarkZither)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=MarkZither "Documentation") | [
Rob Phoenix](https://www.robphoenix.com)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=robphoenix "Documentation") | [
Steve Lathrop](https://www.SteLa.io)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=slathrop "Code") [πŸ“–](https://github.com/netlify/netlify-cms/commits?author=slathrop "Documentation") [πŸ’‘](#example-slathrop "Examples") | [
Maciej Matuszewski](https://github.com/maciejmatu)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=maciejmatu "Code") | [
Eko Eryanto](https://github.com/ekoeryanto)
[πŸ”Œ](#plugin-ekoeryanto "Plugin/utility libraries") | | [
Taylor D. Edmiston](http://blog.tedmiston.com/)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=tedmiston "Documentation") | [
Daniel Mahon](https://www.mahonstudios.com)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=danielmahon "Code") | [
Evan Hennessy](https://www.hennessyevan.com)
[πŸ”Œ](#plugin-hennessyevan "Plugin/utility libraries") | [
Hasan Azizul Haque](https://hasanavi.me)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=hasanavi "Code") [πŸ“–](https://github.com/netlify/netlify-cms/commits?author=hasanavi "Documentation") [πŸ€”](#ideas-hasanavi "Ideas, Planning, & Feedback") | [
Robert Karlsson](https://github.com/robertkarlsson)
[πŸ›](https://github.com/netlify/netlify-cms/issues?q=author%3Arobertkarlsson "Bug reports") | [
Gil Greenberg](http://gilgreenberg.com)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=gil-- "Code") | [
Tyler Ipson](http://loremipson.com)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=loremipson "Documentation") | -| [
Jake Rayson](https://www.growdigital.org/)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=growdigital "Code") [πŸ“](#blog-growdigital "Blogposts") [πŸ’‘](#example-growdigital "Examples") | [
Kurt collins](https://github.com/kurtgcollins)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=kurtgcollins "Documentation") | [
Casey Schroeder](https://github.com/cdschroeder)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=cdschroeder "Documentation") | [
Cory Williamson-Cardneau](http://cory.williamson-cardneau.com)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=cory-wc "Documentation") | +| [
Jake Rayson](https://www.growdigital.org/)
[πŸ’»](https://github.com/netlify/netlify-cms/commits?author=growdigital "Code") [πŸ“](#blog-growdigital "Blogposts") [πŸ’‘](#example-growdigital "Examples") | [
Kurt collins](https://github.com/kurtgcollins)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=kurtgcollins "Documentation") | [
Cory Williamson-Cardneau](http://cory.williamson-cardneau.com)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=cory-wc "Documentation") | [
Casey Schroeder](https://github.com/cdschroeder)
[πŸ“–](https://github.com/netlify/netlify-cms/commits?author=cdschroeder "Documentation") | [
Mitchell Cash](https://mitchellcash.com)
[πŸ›](https://github.com/netlify/netlify-cms/issues?q=author%3AMitchellCash "Bug reports") [πŸ“–](https://github.com/netlify/netlify-cms/commits?author=MitchellCash "Documentation") | This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!