diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a1441f5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,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 +``` |
