From 4eb7794823897bc334e1b6840ff415e6c8fd4898 Mon Sep 17 00:00:00 2001
From: Bjarke Madsen <bjarke@nordu.net>
Date: Mon, 10 Feb 2025 15:56:59 +0100
Subject: [PATCH] Update readme

---
 compendium-frontend/README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/compendium-frontend/README.md b/compendium-frontend/README.md
index 4d944b55..424dc86d 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
+```
+
+
-- 
GitLab