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

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

Browse Source
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
1 changed files with 38 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
CONTRIBUTING.md
View File

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