aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2024-07-30 19:48:09 +0200
committerGravatar Johannes Christ <[email protected]>2024-08-01 18:05:00 +0200
commit72d370e8bda7f7b02b2f1bb3d0bafdfc6dd2a03a (patch)
tree7ac4cf7e91727a7f0383d3a62528ca200d0dc3ad
parentConfigure Loki to retain logs for 30 days maximum (diff)
Document local linting workflow
Closes #422.
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8b91b28..7a30bec 100644
--- a/README.md
+++ b/README.md
@@ -33,3 +33,13 @@ Infrastructure-related documentation ("the big picture"), can be found in [`docs
Many folders have a `README.md` file within them, which have more detailed explanations on what
that folder, and the files within, is used for.
+
+## Linting
+
+To lint everything with `pre-commit` locally, run the command
+
+```sh
+$ poetry run task lint
+```
+
+Any trivial errors (formatting, minor linting problems) will automatically be fixed.