Skip to content

Commit

Permalink
Merge pull request #320 from IntersectMBO/expand-contributing-doc
Browse files Browse the repository at this point in the history
Added example invocations of project's code formatting policy
  • Loading branch information
jorisdral authored Aug 5, 2024
2 parents f927f66 + 2f1e254 commit b1bdbcf
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand All @@ -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.
patch.

0 comments on commit b1bdbcf

Please sign in to comment.