Skip to content

Commit e8c728e

Browse files
committed
doc: use longer lines in CONTRIBUTING.md
1 parent af961c8 commit e8c728e

File tree

1 file changed

+11
-38
lines changed

1 file changed

+11
-38
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Contributing Guidelines
22

3-
Contributions are very welcome! To hack on the github version, clone the
4-
repository. You can use `cabal`:
3+
Contributions are very welcome! To hack on the github version, clone the repository. You can use `cabal`:
54

65
```shell
76
cabal build all # Install dependencies and build packages
@@ -36,8 +35,7 @@ Some things we like:
3635
- Few dependencies
3736
- -Werror-compatible (7.8, 7.10 and 8.0)
3837

39-
Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs`
40-
files in the repository provide a good baseline for consistency.
38+
Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs` files in the repository provide a good baseline for consistency.
4139

4240
**Important**: please do not modify the versions of the servant packages you are sending patches for.
4341

@@ -70,52 +68,27 @@ for prose.
7068

7169
## PR process
7270

73-
We try to give timely reviews to PRs that pass CI. If CI for your PR fails, we
74-
may close the PR if it has been open for too long (though you should feel free
75-
to reopen when the issues have been fixed).
71+
We try to give timely reviews to PRs that pass CI. If CI for your PR fails, we may close the PR if it has been open for too long (though you should feel free to reopen when the issues have been fixed).
7672

77-
We require two +1 from the maintainers of the repo. If you feel like there has
78-
not been a timely response to a PR, you can ping the Maintainers group (with
79-
`@haskell-servant/maintainers`).
73+
We require two +1 from the maintainers of the repo. If you feel like there has not been a timely response to a PR, you can ping the Maintainers group (with `@haskell-servant/maintainers`).
8074

8175
## New combinators
8276

83-
We encourage people to experiment with new combinators and instances - it is
84-
one of the most powerful ways of using `servant`, and a wonderful way of
85-
getting to know it better. If you do write a new combinator, we would love to
86-
know about it! Either hop on
87-
[#haskell-servant on libera.chat](https://web.libera.chat/#haskell-servant) and
88-
let us know, or open an issue with the `news` tag (which we will close when we
89-
read it).
90-
91-
As for adding them to the main repo: maintaining combinators can be expensive,
92-
since official combinators must have instances for all classes (and new classes
93-
come along fairly frequently). We therefore have to be quite selective about
94-
those that we accept. If you're considering writing a new combinator, open an
95-
issue to discuss it first! Or contribute it to the
96-
[servant-contrib](https://github.com/haskell-servant/servant-contrib) repository.
97-
You could release your combinator as a separate package, of course.
77+
We encourage people to experiment with new combinators and instances - it is one of the most powerful ways of using `servant`, and a wonderful way of getting to know it better. If you do write a new combinator, we would love to know about it! Either hop on [#haskell-servant on libera.chat](https://web.libera.chat/#haskell-servant) and let us know, or open an issue with the `news` tag (which we will close when we read it).
9878

79+
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 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 issue to discuss it first! Or contribute it to the [servant-contrib](https://github.com/haskell-servant/servant-contrib) repository.
80+
You could release your combinator as a separate package, of course.
9981

10082
## New classes
10183

102-
The main benefit of having a new class and package in the main servant repo is
103-
that we get to see via CI whether changes to other packages break the build.
104-
Open an issue to discuss whether a package should be added to the main repo. If
105-
we decide that it can, you can still keep maintainership over it.
84+
The main benefit of having a new class and package in the main servant repo is that we get to see via CI whether changes to other packages break the build. Open an issue to discuss whether a package should be added to the main repo. If we decide that it can, you can still keep maintainership over it.
10685

107-
Whether or not you want your package to be in the repo, create an issue with
108-
the `news` label if you make a new package so we can know about it!
86+
Whether or not you want your package to be in the repo, create an issue with the `news` label if you make a new package so we can know about it!
10987

11088
## Release policy
11189

112-
We are currently moving to a more aggressive release policy, so that you can get
113-
what you contribute from Hackage fairly soon. However, note that prior to major
114-
releases it may take some time in between releases.
90+
We are currently moving to a more aggressive release policy, so that you can get what you contribute from Hackage fairly soon. However, note that prior to major releases it may take some time in between releases.
11591

11692
## Reporting security issues
11793

118-
Please email haskell-servant-maintainers AT googlegroups DOT com. This group is
119-
private, and accessible only to known maintainers. We will then discuss how to
120-
proceed. Please do not make the issue public before we inform you that we have
121-
a patch ready.
94+
Please email haskell-servant-maintainers AT googlegroups DOT com. This group is private, and accessible only to known maintainers. We will then discuss how to proceed. Please do not make the issue public before we inform you that we have a patch ready.

0 commit comments

Comments
 (0)