Skip to content

Commit 72d370e

Browse files
committed
Document local linting workflow
Closes #422.
1 parent dc4a6c2 commit 72d370e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,13 @@ Infrastructure-related documentation ("the big picture"), can be found in [`docs
3333

3434
Many folders have a `README.md` file within them, which have more detailed explanations on what
3535
that folder, and the files within, is used for.
36+
37+
## Linting
38+
39+
To lint everything with `pre-commit` locally, run the command
40+
41+
```sh
42+
$ poetry run task lint
43+
```
44+
45+
Any trivial errors (formatting, minor linting problems) will automatically be fixed.

0 commit comments

Comments
 (0)