Skip to content

Commit

Permalink
CONTRIBUTING.md: mention formatting pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
amesgen authored and mrkkrp committed Jul 10, 2024
1 parent 271bacc commit 3f2e318
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 3f2e318

Please sign in to comment.