diff --git a/.all-contributorsrc b/.all-contributorsrc
index 9653f057..353a5434 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -975,6 +975,16 @@
"contributions": [
"code"
]
+ },
+ {
+ "login": "loremipson",
+ "name": "Tyler Ipson",
+ "avatar_url": "https://avatars0.githubusercontent.com/u/649890?v=4",
+ "profile": "http://loremipson.com",
+ "contributions": [
+ "doc"
+ ]
}
- ]
+ ],
+ "repoType": "github"
}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9377e1b9..ead96aa1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -10,33 +10,79 @@ please read the [code of conduct](CODE_OF_CONDUCT.md).
```sh
$ git clone https://github.com/netlify/netlify-cms
$ cd netlify-cms
-$ yarn
+$ yarn start
```
-## Building
+## Available scripts
+
+### `bootstrap`
+
+Installs and bootstraps any CMS package dependencies.
+
+#### Usage
```sh
-$ npm run build
+$ yarn bootstrap
```
-## Testing
+### `watch`
+
+Watches all CMS packages and transpiles them on change.
+
+#### Usage
```sh
-$ npm run test
+$ yarn watch
```
+### `start`
+
+Starts the development server. This task runs both the `bootstrap` and `watch` scripts.
+
+#### Usage
+
```sh
-$ npm run test:watch
+$ yarn start
```
+### `clean`
+
+Removes all of the CMS package `dist` directories.
+
+#### Usage
+
```sh
-$ npm run lint
+yarn clean
```
-## Running the server
+### `reset`
+
+Runs the `clean` script and removes all the `node_modules` from the CMS packages.
+
+#### Usage
```sh
-$ npm run start
+yarn reset
+```
+
+### `build`
+
+Runs the `clean` script and builds the CMS packages.
+
+#### Usage
+
+```sh
+yarn build
+```
+
+### `test`
+
+Runs all the CMS package tests.
+
+#### Usage
+
+```sh
+yarn test
```
## Pull Requests
diff --git a/README.md b/README.md
index 5cdb470d..8902d0c9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# Netlify CMS
-[![All Contributors](https://img.shields.io/badge/all_contributors-110-orange.svg)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-112-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
| [
Tim Carry](http://www.pixelastic.com/)
[π»](https://github.com/netlify/netlify-cms/commits?author=pixelastic "Code") [π¨](#design-pixelastic "Design") [π](https://github.com/netlify/netlify-cms/commits?author=pixelastic "Documentation") | [
Sol Park](https://github.com/solpark)
[π»](https://github.com/netlify/netlify-cms/commits?author=solpark "Code") | [
Michael Romani](https://github.com/MichaelRomani)
[π»](https://github.com/netlify/netlify-cms/commits?author=MichaelRomani "Code") | [
Xifeng Jin](http://linkedin/in/xifengjin88)
[π](https://github.com/netlify/netlify-cms/issues?q=author%3Axifengjin88 "Bug reports") [π»](https://github.com/netlify/netlify-cms/commits?author=xifengjin88 "Code") | [
Pedro Duarte](http://pedroduarte.me)
[π](https://github.com/netlify/netlify-cms/issues?q=author%3Apeduarte "Bug reports") [π»](https://github.com/netlify/netlify-cms/commits?author=peduarte "Code") [π](https://github.com/netlify/netlify-cms/commits?author=peduarte "Documentation") | [
Antonio Argote](http://antonioargote.com)
[π¨](#design-Strangehill "Design") | [
Kristaps Taube](https://www.ktaube.com)
[π»](https://github.com/netlify/netlify-cms/commits?author=ktaube "Code") |
| [
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") |
+| [
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") |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
diff --git a/package.json b/package.json
index dbc2315d..d428d681 100644
--- a/package.json
+++ b/package.json
@@ -8,7 +8,8 @@
"reset": "npm run clean && lerna clean --yes",
"test": "cross-env NODE_ENV=test jest --no-cache",
"dryrun": "lerna publish --skip-npm --skip-git",
- "publish": "npm run bootstrap && npm run build && lerna publish"
+ "publish": "npm run bootstrap && npm run build && lerna publish",
+ "add-contributor": "all-contributors add"
},
"browserslist": [
"last 2 Chrome versions",
@@ -59,4 +60,4 @@
"dependencies": {
"jest-emotion": "^9.2.6"
}
-}
+}
\ No newline at end of file