You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,6 +57,20 @@ WIP (Work In Progress) Docs on how to do this:
57
57
58
58
2. In the repository root directory (`www` by default), run `pip install -r requirements.txt` to install sphinx and other requirements.
59
59
60
+
### Setting up pre-commit hooks
61
+
62
+
This repository uses [pre-commit](https://pre-commit.com/) to run automated checks on files before committing. After installing the requirements, set up the pre-commit hooks:
63
+
64
+
```
65
+
pre-commit install
66
+
```
67
+
68
+
The hooks will now run automatically when you commit changes. You can also run them manually:
69
+
70
+
```
71
+
pre-commit run --all-files
72
+
```
73
+
60
74
### Previewing the docs locally
61
75
62
76
> Remember to activate the virtual environment using the appropriate command for your OS and Shell before running the following commands.
0 commit comments