Skip to content

Commit b6b9c27

Browse files
committed
Add CONTRIBUTING.md
1 parent 016791a commit b6b9c27

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Patches welcome!
2+
3+
- If you are only going to bump bounds:
4+
- If it's really **only bounds**, please simply open an issue (so you'll have a URL to refer to). I have a semi-automated process to make revisions, pull requests only disturb it.
5+
- If patch includes **source code change** (i.e. I'll need to make a release), and it's a patch to support **newer base/GHC version**:
6+
- Amend `tested-with` to include that GHC
7+
- Regenerate `.github/workflows/haskell-ci.yml` with `haskell-ci regenerate` (get the latest from [GitHub haskell-ci/haskell-ci](https://github.com/haskell-ci/haskell-ci))
8+
9+
- Don't edit `CHANGELOG.md`, rather include a copyable entry in your pull request description. I often process pull requests in bulk, and everyone editing the `CHANGELOG.md` causes unnecessary conflicts.
10+
- For the same reason, do not edit `version` or `x-revision`
11+
12+
- I use [`stylish-haskell`](https://github.com/jaspervdj/stylish-haskell) to format imports. I encourage you to use it too, when contributing.
13+
- General code style is 4 spaces, just look around how it looks, it's not so strict.

0 commit comments

Comments
 (0)