Skip to content

Commit 89a0e86

Browse files
authored
Update contributing.md (#510)
2 parents e88eaa0 + c59d048 commit 89a0e86

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/contributing.md

+5
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,11 @@ It is also generally useful to set add an `override.env` file to the project's r
9090
the line `USE_LOCAL_DEV=true` added. This will allow utility scripts `./scripts/up.sh` and `./scripts/down.sh`
9191
to start docker containers in a way that reflects local changes.
9292

93+
### Pre-commit
94+
Finally, configure your [pre-commit](https://pre-commit.com) hooks using `pre-commit install`.
95+
This will install some hooks to run before a commit can be made, these hooks will run various checks such as a code formatter, linter, file validation, and unit tests.
96+
These hooks help make sure formatting is more homogeneous across the project, and that no breaking changes are accidentally committed.
97+
9398
## Making a Code Changes
9499
See the ["Developer Documentation"](developer/index.md) for the technical documentation of this project.
95100
More to be added.

0 commit comments

Comments
 (0)