tweag/ormolu
1
1
Fork 0
mirror of https://github.com/tweag/ormolu.git synced 2024-08-17 00:40:27 +03:00
Code Issues Projects Releases Wiki Activity

CONTRIBUTING.md: mention formatting pre-commit hook

Browse Source
This commit is contained in:
Alexander Esgen 2024-07-10 16:41:43 +02:00 committed by Mark Karpov
parent 271bacc727
commit 3f2e3180d7
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -40,7 +40,13 @@ To regenerate outputs that have changed, you can set the
## Formatting
Use `nix run .#format` script to format Ormolu with the current version of
Ormolu. If Ormolu is not formatted like this, the CI will fail.
- Use `nix run .#format` script to format Ormolu with the current version of
Ormolu.
- Additional formatters are configured via a pre-commit hook which is
automatically installed when entering the Nix shell. You can also run it via
`pre-commit run`/`pre-commit run -a`.
If Ormolu is not formatted like this, the CI will fail.
[issues]: https://github.com/tweag/ormolu/issues