eeva/servant
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #684 from phadej/contributing

Browse Source 
Update contributing
This commit is contained in:
Oleg Grenrus 2017-01-22 01:10:17 +02:00 committed by GitHub
commit 0b981322c9
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -11,9 +11,9 @@ repository. You can use `cabal`:
Or `stack`: Or `stack`:
```shell ```shell
stack setup # Downloads and installs a proper GHC version if necessary stack setup # Downloads and installs a proper GHC version if necessary
stack build # Install and build packages stack build --fast --pedantic # Install dependencies and build packages
stack test # Run all the tests stack test # Run all the tests
``` ```
Or `nix`: Or `nix`:
@ -29,7 +29,7 @@ Some things we like:
- Explicit imports - Explicit imports
- Upper and lower bounds for packages - Upper and lower bounds for packages
- Few dependencies - Few dependencies
- -Werror-compatible (for both 7.8 and 7.10) - -Werror-compatible (7.8, 7.10 and 8.0)
Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs` Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
files in the repository provide a good baseline for consistency. files 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,
since official combinators must have instances for all classes (and new classes since official combinators must have instances for all classes (and new classes
come along fairly frequently). We therefore have to be quite selective about come along fairly frequently). We therefore have to be quite selective about
those that we accept. If you're considering writing a new combinator, open an those that we accept. If you're considering writing a new combinator, open an
issue to discuss it first! (You could release your combinator as a separate issue to discuss it first! Or contribute it to the
package, of course.) [servant-contrib](https://github.com/haskell-servant/servant-contrib) repository.
You could release your combinator as a separate package, of course.
## New classes ## New classes