From 3f2e3180d7fc4060fd7580e7d1c4c03b910a5150 Mon Sep 17 00:00:00 2001 From: Alexander Esgen Date: Wed, 10 Jul 2024 16:41:43 +0200 Subject: [PATCH] CONTRIBUTING.md: mention formatting pre-commit hook --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb5db79..ddea7ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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