From 3027b96343bdf45a56eb30e329fdfc421c28b111 Mon Sep 17 00:00:00 2001 From: Nathan Broadbent Date: Fri, 14 Dec 2018 18:54:42 +0700 Subject: [PATCH] Update Contributing instructions --- README.md | 8 +++++--- package.json | 1 + 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 765a8fe..a38db44 100644 --- a/README.md +++ b/README.md @@ -159,10 +159,12 @@ Before submitting a pull request, please check the following: - Run `yarn test` - 100% test coverage - Coverage will be printed after running tests. - - Open the coverage results in your browser: `open coverage/lcov-report/index.html` + - Check the coverage results in your browser: `open coverage/lcov-report/index.html` +- No ESLint errors + - `yarn run lint` - All code is formatted with [Prettier](https://prettier.io/) - - Run `prettier --write **/*.js` - - If you use VS Code, I recommend enabling the `formatOnSave` option. + - `yarn run format` + - If you use VS Code, you should enable the `formatOnSave` option. ## License diff --git a/package.json b/package.json index 22b165d..e1b3ddf 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "scripts": { "test": "jest", "lint": "eslint --fix lib", + "format": "prettier --write **/*.js", "update_deps": "node scripts/update_deps" }, "repository": {