diff --git a/compendium-frontend/README.md b/compendium-frontend/README.md index 4d944b55489a5d749c407536af42090a781a1823..424dc86d604b5b49eeafb56e945cfd6f7f5cffcd 100644 --- a/compendium-frontend/README.md +++ b/compendium-frontend/README.md @@ -28,3 +28,14 @@ bun run build This will build the new bundle and deploy it to `compendium_v2/static/*`. This should be committed to the repository. +# Linting/Formatting + +For the Flask app, use pep8 (autopep8 in vscode) with a max line length of 120. +The frontend (compendium-frontend) uses eslint for linting checks, and some formatting rules are enforced. + +The build of the frontend is gated by a linting check, to fix anything auto-fixable, use: +```bash +bun run lint:fix +``` + +