git.iko.soy/servant
on v0.9.0.1 help sign in
servant/CONTRIBUTING.md
87 lines 3.2 kB history raw
1# Contributing Guidelines
3Contributions are very welcome! To hack on the github version, clone the
4repository. You can use `cabal`:
6```shell
7./scripts/start-sandbox.sh # Initialize the sandbox and add-source the packages
8./scripts/test-all.sh # Run all the tests
9```
11Or `stack`:
13```shell
14stack setup # Downloads and installs a proper GHC version if necessary
15stack build # Install and build packages
16stack test # Run all the tests
17```
19Or `nix`:
20```shell
21./scripts/generate-nix-files.sh # Get up-to-date shell.nix files
22```
25## General
27Some things we like:
29- Explicit imports
30- Upper and lower bounds for packages
31- Few dependencies
32- -Werror-compatible (for both 7.8 and 7.10)
34Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
35files in the repository provide a good baseline for consistency.
37Please include a description of the changes in your PR in the `CHANGELOG.md` of
38the packages you've changed. And of course, write tests!
40## PR process
42We try to give timely reviews to PRs that pass CI. If CI for your PR fails, we
43may close the PR if it has been open for too long (though you should feel free
44to reopen when the issues have been fixed).
46We require two +1 from the maintainers of the repo. If you feel like there has
47not been a timely response to a PR, you can ping the Maintainers group (with
48`@haskell-servant/maintainers`).
50## New combinators
52We encourage people to experiment with new combinators and instances - it is
53one of the most powerful ways of using `servant`, and a wonderful way of
54getting to know it better. If you do write a new combinator, we would love to
55know about it! Either hop on #servant on freenode and let us know, or open an
56issue with the `news` tag (which we will close when we read it).
58As for adding them to the main repo: maintaining combinators can be expensive,
59since official combinators must have instances for all classes (and new classes
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
62issue to discuss it first! (You could release your combinator as a separate
63package, of course.)
66## New classes
68The main benefit of having a new class and package in the main servant repo is
69that we get to see via CI whether changes to other packages break the build.
70Open an issue to discuss whether a package should be added to the main repo. If
71we decide that it can, you can still keep maintainership over it.
73Whether or not you want your package to be in the repo, create an issue with
74the `news` label if you make a new package so we can know about it!
76## Release policy
78We are currently moving to a more aggresive release policy, so that you can get
79what you contribute from Hackage fairly soon. However, note that prior to major
80releases it may take some time in between releases.
82## Reporting security issues
84Please email haskell-servant-maintainers AT googlegroups DOT com. This group is
85private, and accessible only to known maintainers. We will then discuss how to
86proceed. Please do not make the issue public before we inform you that we have
87a patch ready.