From b5627d0431379cec356d7cc0707994ece0a67038 Mon Sep 17 00:00:00 2001 From: Frazer Smith Date: Fri, 26 Jan 2024 07:25:39 +0000 Subject: [PATCH] docs(contributing): add `lint:fix` step --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e668d4c2..839bf607 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,10 +46,11 @@ Before submitting a pull request back to the main repository, please make sure y 1. Pull request base branch is set to `main`. All pull requests should be forked from and merged back to `main` 2. Run `npm test` to check the code adheres to the defined ESLint style and that it passes the Jest tests -3. Run `npm run lint:prettier:fix` to run the Prettier code formatter over the code -4. Run `npm run lint:licenses` if adding or updating production dependencies to check they use permissive licenses +3. Run `npm run lint:fix` to automatically fix any ESLint errors +4. Run `npm run lint:prettier:fix` to automatically fix any Prettier errors +5. Run `npm run lint:licenses` if adding or updating production dependencies to check they use permissive licenses -Steps 2. and 4. are automatically run by a pre-commit hook added by [Husky](https://typicode.github.io/husky/#/). +Steps 2. and 5. are automatically run by a pre-commit hook added by [Husky](https://typicode.github.io/husky/#/). ## Issues