<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class="">I'm happy with this direction, though I don't think we should expect that even capital letters will actually make people notice the text. One small change to suggest, below:<br class=""><div><br class=""><blockquote type="cite" class=""><div class="">On Feb 23, 2021, at 11:14 AM, Simon Peyton Jones via ghc-devs <<a href="mailto:ghc-devs@haskell.org" class="">ghc-devs@haskell.org</a>> wrote:</div><div class=""><div class="WordSection1" style="page: WordSection1; caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 12px; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none;"><br class=""><p class="MsoNormal" style="margin: 6pt 0cm; font-size: 11pt; font-family: Calibri, sans-serif;"><b class=""><span style="font-size: 14pt;" class="">Proposed new template<o:p class=""></o:p></span></b></p><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">PLEASE REPLACE ALL OF THIS TEXT with a description of your merge request, including<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""><o:p class=""> </o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">* A description of what the Merge Request does. For a single-commit MR, a copy of the<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""> commit message is often perfect.<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""><o:p class=""> </o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">* A reference (e.g. #19415) to the ticket that led to this MR, and that describes the<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""> problem that this MR solves. Almost all MRs need a ticket, except the tiniest<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""> changes (e.g. code formatting)<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""> - A ticket describes a *<span style="font-weight: normal;" class="">problem</span>*<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""> - A merge request describes a *<span style="font-weight: normal;" class="">solution</span>* to that problem.<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""><o:p class=""> </o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">While you are encouraged to write a good MR Description, it’s not compulsory.<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">You could just be putting up the MR to share with a colleague, for example.<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""><o:p class=""> </o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">But if you want (a) to get code reviews from others, or<span class="Apple-converted-space"> </span><o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""> (b) to land the patch in GHC,<span class="Apple-converted-space"> </span><o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">please do follow these guidelines.</div></div></div></blockquote><div><br class=""></div><div>If you are not ready for wide review, please start the MR name with the prefix "WIP:", for "work in progress".</div><br class=""><blockquote type="cite" class=""><div class="WordSection1" style="page: WordSection1; caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 12px; font-style: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none;"><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""><o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""><o:p class=""> </o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class="">For general style guidance see<o:p class=""></o:p></div><div style="margin: 0cm 0cm 0cm 22.7pt; font-size: 10pt; font-family: "Courier New"; font-weight: bold;" class=""><a href="https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style" style="color: rgb(5, 99, 193); text-decoration: underline;" class="">https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style</a><o:p class=""></o:p></div><br class=""></div></blockquote><br class=""></div><div><br class=""></div>Richard</body></html>