From c8481269dc006ba6e119da9e1081a107e10cc290 Mon Sep 17 00:00:00 2001 From: Richard Tan Date: Mon, 15 Jun 2020 20:18:15 +1000 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57d466e91..8cde88e46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,9 +86,13 @@ you have several options: # Code Style -We're using Prettier, ESlint and the Airbnb preset. +We're using Prettier, ESlint and the Airbnb preset. To fix errors which are automatically fixable, run: -## Verifying linting style +``` +npm run format +``` + +To run the linter, run: ``` npm run lint @@ -96,11 +100,25 @@ npm run lint # Testing +There are a few test scripts, depending on what type of testing you want to run. + +**Unit tests** + +To run unit tests only: + +``` +npm run test:unit +``` + +**Watch mode** + +To run all tests in watch mode (this skips `npm install`): + ``` -npm test +npm run test:watch ``` -# Test coverage +**Test coverage** ``` npm run test:cov