Magnus pushed to branch wip/mangoiv/revise-merge-template at Glasgow Haskell Compiler / GHC Commits: 85f5dd3c by mangoiv at 2026-04-23T12:06:43+02:00 contributing: adjust MR template to be less verbose - MR template only shows text that is relevant for submissiong - MR template was rewritten so it's readable from a user's and reviewer's perspective Resolves #27165 Co-Authored-By: @sheaf - - - - - 1 changed file: - .gitlab/merge_request_templates/Default.md Changes: ===================================== .gitlab/merge_request_templates/Default.md ===================================== @@ -1,43 +1,44 @@ + +<!-- 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 address the following points: - - * [ ] if your MR touches `base` (or touches parts of `ghc-internal` used - or re-exported by `base`) more substantially than just amending comments - or documentation, you likely need to raise a - [CLC proposal](https://github.com/haskell/core-libraries-committee#base-package) - before merging it. - * [ ] if your MR may break existing programs (e.g. 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][adding test]. - * [ ] updates the users guide if applicable - * [ ] add a changelog entry in `changelog.d/` for user-facing changes (see [changelog guide][changelog]). - If this MR does not need a changelog entry, apply the ~"no-changelog" label. +Please read the checklist below to make sure your contribution fulfills these +expectations. 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:`. - +title with Draft: +--> + +## Changes contained in this patch +<!-- Where is the key part of this patch? That is, what should reviewers look at first? --> + + +## MR Checklist +<!-- Please take a few moments to address the following points: --> + +- [ ] This MR solves the problem described in the following issue: <!-- issue number here (please open a new issue if there isn't one) --> +- [ ] A changelog entry was added in `changelog.d/` for user-facing changes (see [changelog guide][changelog]). + If this MR does not need a changelog entry, the ~"no-changelog" label was applied. +- [ ] This MR does not make any significant changes to `base`, or it has an accompanying [CLC proposal](https://github.com/haskell/core-libraries-committee#base-package). +- [ ] If this MR has the potential to break user programs, the ~"user-facing" label was applied to + test against head.hackage. +- [ ] All commits are either individually buildable or squashed. +- [ ] Commit messages describe *what they do*, referring to tickets using `#NNNNN` syntax. +- [ ] Source comments describing the change were added. For larger changes [notes][notes] and + cross-references from the relevant places were added as applicable. +- [ ] [Testcases to the testsuite][adding test] were added as applicable. +- [ ] The users guide was updated as applicable. + +<!-- By default a minimal validation pipeline is run on each merge request, the ~full-ci label can be applied to perform additional validation checks if your MR affects a more unusual configuration. -Once your change is ready please remove the `WIP:` tag and wait for review. If +Once your change is ready please remove the `Draft:` tag and wait for review. If no one has offered a review in a few days then please leave a comment mentioning @triagers and apply the ~"Blocked on Review" label. +--> [notes]: https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style#comments-in... [adding test]: https://gitlab.haskell.org/ghc/ghc/wikis/building/running-tests/adding View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/85f5dd3cdfd1753573e8ac0d75f93a0a... -- View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/85f5dd3cdfd1753573e8ac0d75f93a0a... You're receiving this email because of your account on gitlab.haskell.org.