summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorEugen Wissner <belka@caraus.de>2020-11-02 08:24:48 +0100
committerEugen Wissner <belka@caraus.de>2020-11-02 08:24:48 +0100
commitafcf9aaa14e925ca137ec956e3bfd47d2506c904 (patch)
treeb108a19882c9057dc7c7ad9166c58b05ed08bd80 /CONTRIBUTING.md
parent6e8d8a34a1ce07b8d9cd10d8e5c3e009d17cfdf7 (diff)
downloadgraphql-afcf9aaa14e925ca137ec956e3bfd47d2506c904.tar.gz
Write documentation out of the source tree
In a Wiki.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md31
1 files changed, 0 insertions, 31 deletions
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
-```