From afcf9aaa14e925ca137ec956e3bfd47d2506c904 Mon Sep 17 00:00:00 2001 From: Eugen Wissner Date: Mon, 2 Nov 2020 08:24:48 +0100 Subject: Write documentation out of the source tree In a Wiki. --- CONTRIBUTING.md | 31 ------------------------------- 1 file changed, 31 deletions(-) delete mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index a1441f5..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,31 +0,0 @@ -# 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 -``` -- cgit v1.2.3