summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: a1441f5932ef95d88af46bd830566c527ff2b00f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Contributing guidelines

## Testing

To ensure all code changes adhere to existing code quality standards, some
automatic checks can be run locally.

Ensure that the code builds without warnings and passes the tests:

```sh
stack test --pedantic
```

And also run the linter on your code:

```sh
stack build hlint
stack exec hlint -- src tests
```

Build the documentation and check if you get any warnings:

```sh
stack haddock
```

Validate that literate Haskell (tutorials) files compile without any warnings:

```sh
stack ghc -- -Wall -fno-code docs/tutorial/*.lhs
```