diff --git a/README.md b/README.md index a2e92ff..6ab4556 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,13 @@ Or pull things up in ghci with: stack ghci +## Contributing + +If you'd like to contribute to the repo, use the above installation instructions to get started. + +When you're ready, make sure that the code compiles with the `Development` flag, i.e.: + + stack build --flag queryparser:development ## Use diff --git a/queryparser.cabal b/queryparser.cabal index e3bf1be..7d8eacc 100644 --- a/queryparser.cabal +++ b/queryparser.cabal @@ -48,6 +48,11 @@ build-type: Simple -- Constraint on the version of Cabal needed to build this package. cabal-version: >=1.10 +flag development { + description: Enable development level of strictness + default: False + manual: True +} library -- Modules exported by the library. @@ -104,7 +109,10 @@ library hs-source-dirs: src - ghc-options: -Wall -Werror + ghc-options: -Wall + + if flag(development) + ghc-options: -Werror -- Base language which the package is written in. default-language: Haskell2010 @@ -118,7 +126,10 @@ benchmark queryparser-bench , text hs-source-dirs: bench - ghc-options: -Wall -Werror -with-rtsopts=-M5M + ghc-options: -Wall -with-rtsopts=-M5M + + if flag(development) + ghc-options: -Werror default-language: Haskell2010 default-extensions: OverloadedStrings