summaryrefslogtreecommitdiff
path: root/.gitlab/merge_request_templates/merge-request.md
blob: e4d28afa32bdf9960b10f90118a480ee0917cbdb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Thank you for your contribution to GHC!

**Please read the checklist below to make sure your contribution fulfills these
expectations. Also please answer the following question in your MR description:**

**Where is the key part of this patch? That is, what should reviewers look at first?**

Please take a few moments to verify that your commits fulfill the following:

 * [ ] are either individually buildable or squashed
 * [ ] have commit messages which describe *what they do*
   (referring to [Notes][notes] and tickets using `#NNNN` syntax when
   appropriate)
 * [ ] have added source comments describing your change. For larger changes you
   likely should add a [Note][notes] and cross-reference it from the relevant
   places.
 * [ ] add a [testcase to the testsuite](https://gitlab.haskell.org/ghc/ghc/wikis/building/running-tests/adding).
 * [ ] if your MR affects library interfaces (e.g. changes `base`) or affects whether GHC will accept user-written code, please add
   the ~"user facing" label.
 * [ ] updates the users guide if applicable
 * [ ] mentions new features in the release notes for the next release

If you have any questions don't hesitate to open your merge request and inquire
in a comment. If your patch isn't quite done yet please do add prefix your MR
title with `WIP:`.

Once your change is ready please remove the `WIP:` tag and wait for review. If 
no one has offerred review in a few days then please leave a comment mentioning
@triagers.

[notes]: https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style#comments-in-the-source-code