Update readme with lint/format instructions

CityOfDetroit · Sep 29, 2023 · ce1e50a · ce1e50a
1 parent b715463
commit ce1e50a
Showing 1 changed file with 16 additions and 0 deletions.
diff --git 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
+```