docs: add a few more test commands to CONTRIBUTING.md (#2871)

This commit is contained in:
Shawn Erquhart 2019-11-12 15:38:28 -05:00 committed by GitHub
parent 69220b13a2
commit f3eaaa6432
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -24,97 +24,102 @@ $ yarn bootstrap
### Run locally
```sh
$ yarn start
yarn start
```
## Available scripts
### `bootstrap`
### bootstrap
Bootstraps the monorepo.
#### Usage
```sh
$ yarn bootstrap
yarn bootstrap
```
### `watch`
### watch
Watches all CMS packages and transpiles them on change.
#### Usage
```sh
$ yarn watch
yarn watch
```
### `start`
### start
Starts the development server. This task runs both the `bootstrap` and `watch` scripts.
#### Usage
```sh
$ yarn start
yarn start
```
### `clean`
### clean
Removes all of the CMS package `dist` directories.
#### Usage
```sh
yarn clean
```
### `reset`
### reset
Runs the `clean` script and removes all the `node_modules` from the CMS packages.
#### Usage
```sh
yarn reset
```
### `build`
### build
Runs the `clean` script and builds the CMS packages.
#### Usage
```sh
yarn build
```
### `build-preview`
### build-preview
Runs the `build` and `build-preview` scripts in each package and serves the resulting build locally.
#### Usage
```sh
yarn build-preview
```
### `test`
### test
Runs all the CMS package tests.
#### Usage
Runs linting and Jest tests.
```sh
yarn test
```
### `format`
### test:all
Runs linting, Jest, and Cypress tests.
```sh
yarn test:all
```
### test:e2e
Runs Cypress e2e tests.
```sh
yarn test:e2e
```
### test:e2e:dev
Runs Cypress e2e tests on watch mode with an open instance of Chrome.
```sh
yarn test:e2e:dev
```
### format
Formats code and docs according to our style guidelines.
#### Usage
```sh
yarn format
```