From f3eaaa6432fc171a05ecb001e35415f62c08f998 Mon Sep 17 00:00:00 2001 From: Shawn Erquhart Date: Tue, 12 Nov 2019 15:38:28 -0500 Subject: [PATCH] docs: add a few more test commands to CONTRIBUTING.md (#2871) --- CONTRIBUTING.md | 71 ++++++++++++++++++++++++++----------------------- 1 file changed, 38 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 732cfcd4..e5170ade 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 ```