diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fba61b1d5..65b4d4b28 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,6 +76,23 @@ format `*.cabal` files. We also use `cabal check` to sanity check our cabal files. See the helpful scripts in the [scripts folder](./scripts/), and the [`stylish-haskell` configuration file](./.stylish-haskell.yaml). +To perform a pre-commit code formatting pass, run one of the following: + + * If you prefer `fd` and have it installed on your system: + ``` + ./format-stylish-fd.sh + ./format-cabal-fd.sh + ./check-cabal.sh + ./haddocks.sh + ``` + + * Otherwise using Unix `find`: + ``` + ./format-stylish-find.sh + ./format-cabal-find.sh + ./check-cabal.sh + ./haddocks.sh + ## Pull requests The following are requirements for merging a PR into `main`: @@ -98,4 +115,4 @@ like `A.B.C.D`. * `A.B` is the *major* version number. A bump indicates a breaking change. * `C` is the *minor* version number. A bump indicates a non-breaking change. * `D` is the *patch* version number. A bump indicates a small, non-breaking - patch. \ No newline at end of file + patch.