From ce1e50a820242764f84e19d57d772843453963cd Mon Sep 17 00:00:00 2001 From: Max Morgan Date: Fri, 29 Sep 2023 10:33:46 -0400 Subject: [PATCH] Update readme with lint/format instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index d285ff99..c54cf81c 100644 --- a/README.md +++ b/README.md @@ -56,3 +56,19 @@ Use Storybooks [built-in test-runner](https://storybook.js.org/docs/react/writin ``` $ yarn test-storybook ``` + +### Formatting and Linting + +The remote repository will enforce ESLint rules and Prettier formatting. + +To check ESLint and Prettier formatting locally: + +``` +$ yarn lint +``` + +To format the code in `./src/`: + +``` +$ yarn prettier -w ./src +```