I often see MRs in my inbox that say
Thank you for your contribution to GHC!
Please take a few moments to verify that your commits fulfill the following:
[ ] are either individually buildable or squashed
This is because the author hasn't changed the Description of the MR, but rather
has left the template text unchanged.
As a way to "nudge" authors to give reviewers more information, I suggest
replacing the template text with the draft below. Does anyone have any views,
for or against?
Simon
Proposed new template
PLEASE REPLACE ALL OF THIS TEXT with a description of your merge request,
including
* A description of what the Merge Request does. For a single-commit MR, a copy
of the
commit message is often perfect.
* A reference (e.g. #19415) to the ticket that led to this MR, and that
describes the
problem that this MR solves. Almost all MRs need a ticket, except the tiniest
changes (e.g. code formatting)
- A ticket describes a *problem*
- A merge request describes a *solution* to that problem.
While you are encouraged to write a good MR Description, it's not compulsory.
You could just be putting up the MR to share with a colleague, for example.
But if you want (a) to get code reviews from others, or
(b) to land the patch in GHC,
please do follow these guidelines.
For general style guidance see
https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style
For completeness, the current template is
Thank you for your contribution to GHC!
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).
* [ ] replace this message with a description motivating your change
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:`.
[notes]:
https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style#comments-in-the-source-code
_______________________________________________
ghc-devs mailing list
ghc-devs@haskell.org
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
