<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:Wingdings;
panose-1:5 0 0 0 0 0 0 0 0 0;}
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin-top:6.0pt;
margin-right:0cm;
margin-bottom:6.0pt;
margin-left:0cm;
font-size:11.0pt;
font-family:"Calibri",sans-serif;
mso-fareast-language:EN-US;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:#0563C1;
text-decoration:underline;}
p.Code, li.Code, div.Code
{mso-style-name:Code;
margin-top:0cm;
margin-right:0cm;
margin-bottom:0cm;
margin-left:22.7pt;
font-size:10.0pt;
font-family:"Courier New";
mso-fareast-language:EN-US;
font-weight:bold;}
span.EmailStyle18
{mso-style-type:personal-compose;
font-family:"Calibri",sans-serif;
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;
font-family:"Calibri",sans-serif;
mso-fareast-language:EN-US;}
.MsoPapDefault
{mso-style-type:export-only;
margin-top:6.0pt;
margin-right:0cm;
margin-bottom:6.0pt;
margin-left:0cm;}
@page WordSection1
{size:612.0pt 792.0pt;
margin:72.0pt 72.0pt 72.0pt 72.0pt;}
div.WordSection1
{page:WordSection1;}
/* List Definitions */
@list l0
{mso-list-id:590284733;
mso-list-template-ids:-123991472;}
@list l0:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:36.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level2
{mso-level-number-format:bullet;
mso-level-text:o;
mso-level-tab-stop:72.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:"Courier New";
mso-bidi-font-family:"Times New Roman";}
@list l0:level3
{mso-level-number-format:bullet;
mso-level-text:\F0A7;
mso-level-tab-stop:108.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Wingdings;}
@list l0:level4
{mso-level-number-format:bullet;
mso-level-text:\F0A7;
mso-level-tab-stop:144.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Wingdings;}
@list l0:level5
{mso-level-number-format:bullet;
mso-level-text:\F0A7;
mso-level-tab-stop:180.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Wingdings;}
@list l0:level6
{mso-level-number-format:bullet;
mso-level-text:\F0A7;
mso-level-tab-stop:216.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Wingdings;}
@list l0:level7
{mso-level-number-format:bullet;
mso-level-text:\F0A7;
mso-level-tab-stop:252.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Wingdings;}
@list l0:level8
{mso-level-number-format:bullet;
mso-level-text:\F0A7;
mso-level-tab-stop:288.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Wingdings;}
@list l0:level9
{mso-level-number-format:bullet;
mso-level-text:\F0A7;
mso-level-tab-stop:324.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
mso-ansi-font-size:10.0pt;
font-family:Wingdings;}
ol
{margin-bottom:0cm;}
ul
{margin-bottom:0cm;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-GB" link="#0563C1" vlink="#954F72" style="word-wrap:break-word">
<div class="WordSection1">
<p class="MsoNormal">I often see MRs in my inbox that say<o:p></o:p></p>
<p class="Code"><span lang="EN">Thank you for your contribution to GHC!<o:p></o:p></span></p>
<p class="Code"><span lang="EN">Please take a few moments to verify that your commits fulfill the following:<o:p></o:p></span></p>
<p class="Code"><span lang="EN">[ ] are either individually buildable or squashed<o:p></o:p></span></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">This is because the author hasn’t changed the Description of the MR, but rather has left the template text unchanged.<o:p></o:p></p>
<p class="MsoNormal">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?<o:p></o:p></p>
<p class="MsoNormal">Simon<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal"><b><span style="font-size:14.0pt">Proposed new template<o:p></o:p></span></b></p>
<p class="Code">PLEASE REPLACE ALL OF THIS TEXT with a description of your merge request, including<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">* A description of what the Merge Request does. For a single-commit MR, a copy of the<o:p></o:p></p>
<p class="Code"> commit message is often perfect.<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">* A reference (e.g. #19415) to the ticket that led to this MR, and that describes the
<o:p></o:p></p>
<p class="Code"> problem that this MR solves. Almost all MRs need a ticket, except the tiniest<o:p></o:p></p>
<p class="Code"> changes (e.g. code formatting)<o:p></o:p></p>
<p class="Code"> - A ticket describes a *<span style="font-weight:normal">problem</span>*<o:p></o:p></p>
<p class="Code"> - A merge request describes a *<span style="font-weight:normal">solution</span>* to that problem.<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">While you are encouraged to write a good MR Description, it’s not compulsory.<o:p></o:p></p>
<p class="Code">You could just be putting up the MR to share with a colleague, for example.
<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">But if you want (a) to get code reviews from others, or <o:p></o:p></p>
<p class="Code"> (b) to land the patch in GHC, <o:p></o:p></p>
<p class="Code">please do follow these guidelines.<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">For general style guidance see<o:p></o:p></p>
<p class="Code"><a href="https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style">https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style</a><o:p></o:p></p>
<p class="MsoNormal"> <o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal"><b><span style="font-size:14.0pt">For completeness, the current template is<o:p></o:p></span></b></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="Code">Thank you for your contribution to GHC!<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">Please take a few moments to verify that your commits fulfill the following:<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">* [ ] are either individually buildable or squashed<o:p></o:p></p>
<p class="Code">* [ ] have commit messages which describe *what they do*<o:p></o:p></p>
<p class="Code"> (referring to [Notes][notes] and tickets using `#NNNN` syntax when<o:p></o:p></p>
<p class="Code"> appropriate)<o:p></o:p></p>
<p class="Code">* [ ] have added source comments describing your change. For larger changes you<o:p></o:p></p>
<p class="Code"> likely should add a [Note][notes] and cross-reference it from the relevant<o:p></o:p></p>
<p class="Code"> places.<o:p></o:p></p>
<p class="Code">* [ ] add a [testcase to the<o:p></o:p></p>
<p class="Code"> testsuite](<a href="https://gitlab.haskell.org/ghc/ghc/wikis/building/running-tests/adding">https://gitlab.haskell.org/ghc/ghc/wikis/building/running-tests/adding</a>).<o:p></o:p></p>
<p class="Code">* [ ] replace this message with a description motivating your change<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">If you have any questions don't hesitate to open your merge request and inquire<o:p></o:p></p>
<p class="Code">in a comment. If your patch isn't quite done yet please do add prefix your MR<o:p></o:p></p>
<p class="Code">title with `WIP:`.<o:p></o:p></p>
<p class="Code"><o:p> </o:p></p>
<p class="Code">[notes]: <a href="https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style#comments-in-the-source-code">
https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style#comments-in-the-source-code</a><span style="font-size:11.0pt;font-family:"Calibri",sans-serif"><o:p></o:p></span></p>
</div>
</body>
</html>