on master help sign in
Merge pull request #684 from phadej/contributing
0b98132Oleg Grenrus
CONTRIBUTING.md+7−6
@@ -11,9 +11,9 @@ repository. You can use `cabal`:
11Or `stack`:
11Or `stack`:
12
12
13```shell
13```shell
14−stack setup # Downloads and installs a proper GHC version if necessary
14+stack setup # Downloads and installs a proper GHC version if necessary
15−stack build # Install and build packages
15+stack build --fast --pedantic # Install dependencies and build packages
16−stack test # Run all the tests
16+stack test # Run all the tests
17```
17```
18
18
19Or `nix`:
19Or `nix`:
@@ -29,7 +29,7 @@ Some things we like:
29- Explicit imports
29- Explicit imports
30- Upper and lower bounds for packages
30- Upper and lower bounds for packages
31- Few dependencies
31- Few dependencies
32−- -Werror-compatible (for both 7.8 and 7.10)
32+- -Werror-compatible (7.8, 7.10 and 8.0)
33
33
34Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
34Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
35files in the repository provide a good baseline for consistency.
35files in the repository provide a good baseline for consistency.
@@ -59,8 +59,9 @@ As for adding them to the main repo: maintaining combinators can be expensive,
59since official combinators must have instances for all classes (and new classes
59since official combinators must have instances for all classes (and new classes
60come along fairly frequently). We therefore have to be quite selective about
60come along fairly frequently). We therefore have to be quite selective about
61those that we accept. If you're considering writing a new combinator, open an
61those that we accept. If you're considering writing a new combinator, open an
62+issue to discuss it first! Or contribute it to the
63+[servant-contrib](https://github.com/haskell-servant/servant-contrib) repository.
62−issue to discuss it first! (You could release your combinator as a separate
64+You could release your combinator as a separate package, of course.
63−package, of course.)
64
65
65
66
66## New classes
67## New classes