Skip to content

Commit 3f2e318

Browse files
amesgenmrkkrp
authored andcommitted
CONTRIBUTING.md: mention formatting pre-commit hook
1 parent 271bacc commit 3f2e318

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

CONTRIBUTING.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,13 @@ To regenerate outputs that have changed, you can set the
4040

4141
## Formatting
4242

43-
Use `nix run .#format` script to format Ormolu with the current version of
44-
Ormolu. If Ormolu is not formatted like this, the CI will fail.
43+
- Use `nix run .#format` script to format Ormolu with the current version of
44+
Ormolu.
45+
46+
- Additional formatters are configured via a pre-commit hook which is
47+
automatically installed when entering the Nix shell. You can also run it via
48+
`pre-commit run`/`pre-commit run -a`.
49+
50+
If Ormolu is not formatted like this, the CI will fail.
4551

4652
[issues]: https://github.com/tweag/ormolu/issues

0 commit comments

Comments
 (0)