diff options
| author | Ben Gamari <ben@well-typed.com> | 2023-02-07 14:39:30 +0000 |
|---|---|---|
| committer | Ben Gamari <ben@well-typed.com> | 2023-02-07 14:39:30 +0000 |
| commit | b350b4aaf0b87e9c995b2c0345e83fc208331f9d (patch) | |
| tree | 67f90565690af577937cdb019ba6317bdc0062f8 | |
| parent | 3e09cf82ad111e0a6feed81b726849ceaaf3c805 (diff) | |
| download | haskell-b350b4aaf0b87e9c995b2c0345e83fc208331f9d.tar.gz | |
gitlab-template: Emphasize `user facing` labelwip/mr-template
My sense is that the current mention of the ~"user facing" label is
overlooked by many MR authors.
Let's move this point up in the list to make it more likely that it is
seen. Also rephrase some of the points.
| -rw-r--r-- | .gitlab/merge_request_templates/merge-request.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/.gitlab/merge_request_templates/merge-request.md b/.gitlab/merge_request_templates/merge-request.md index e4d28afa32..64086a2643 100644 --- a/.gitlab/merge_request_templates/merge-request.md +++ b/.gitlab/merge_request_templates/merge-request.md @@ -5,18 +5,19 @@ 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: +Please take a few moments to address the following points: - * [ ] 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) + * [ ] if your MR may break existing programs (e.g. touches `base` or causes the + compiler to reject programs), please describe the expected breakage and add + the ~"user facing" label. This will run ghc/head.hackage> to characterise + the effect of your change on Hackage. + * [ ] ensure that your commits are either individually buildable or squashed + * [ ] ensure that your commit messages describe *what they do* + (referring to 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. + * [ ] add a [testcase to the testsuite][adding test]. * [ ] updates the users guide if applicable * [ ] mentions new features in the release notes for the next release @@ -29,3 +30,4 @@ 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 +[adding test]: https://gitlab.haskell.org/ghc/ghc/wikis/building/running-tests/adding |