<div dir="ltr"><div>I'm not sure if it would work here, but I have seen some issue templates, e.g. for haskell-language-server on github[1], use comment markup in the template.</div><div><br></div><div>e.g.</div><div><br></div><div><!--<br>If you encounter a bug or you have a support question, please try to fill out some of the information below.<br>Generally speaking, the information below is meant to help debugging issues but is no prerequisite for opening an issue.<br>--></div><div><br></div><div>This is not rendered on the web or email views, but is seen when editing.</div><div><br></div><div>Alan</div><div><br></div><div>[1] <a href="https://github.com/haskell/haskell-language-server/issues/new">https://github.com/haskell/haskell-language-server/issues/new</a></div><div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, 23 Feb 2021 at 21:21, Richard Eisenberg <<a href="mailto:rae@richarde.dev">rae@richarde.dev</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div style="overflow-wrap: break-word;">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><div><br><blockquote type="cite"><div>On Feb 23, 2021, at 11:14 AM, Simon Peyton Jones via ghc-devs <<a href="mailto:ghc-devs@haskell.org" target="_blank">ghc-devs@haskell.org</a>> wrote:</div><div><div style="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;text-decoration:none"><br><p class="MsoNormal" style="margin:6pt 0cm;font-size:11pt;font-family:Calibri,sans-serif"><b><span style="font-size:14pt">Proposed new template<u></u><u></u></span></b></p><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">PLEASE REPLACE ALL OF THIS TEXT with a description of your merge request, including<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"><u></u> <u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">* A description of what the Merge Request does. For a single-commit MR, a copy of the<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"> commit message is often perfect.<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"><u></u> <u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">* A reference (e.g. #19415) to the ticket that led to this MR, and that describes the<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"> problem that this MR solves. Almost all MRs need a ticket, except the tiniest<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"> changes (e.g. code formatting)<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"> - A ticket describes a *<span style="font-weight:normal">problem</span>*<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"> - A merge request describes a *<span style="font-weight:normal">solution</span>* to that problem.<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"><u></u> <u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">While you are encouraged to write a good MR Description, it’s not compulsory.<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">You could just be putting up the MR to share with a colleague, for example.<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"><u></u> <u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">But if you want (a) to get code reviews from others, or<span> </span><u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"> (b) to land the patch in GHC,<span> </span><u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">please do follow these guidelines.</div></div></div></blockquote><div><br></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><blockquote type="cite"><div style="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;text-decoration:none"><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"><u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"><u></u> <u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold">For general style guidance see<u></u><u></u></div><div style="margin:0cm 0cm 0cm 22.7pt;font-size:10pt;font-family:"Courier New";font-weight:bold"><a href="https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style" style="color:rgb(5,99,193);text-decoration:underline" target="_blank">https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style</a><u></u><u></u></div><br></div></blockquote><br></div><div><br></div>Richard</div>_______________________________________________<br>
ghc-devs mailing list<br>
<a href="mailto:ghc-devs@haskell.org" target="_blank">ghc-devs@haskell.org</a><br>
<a href="http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs" rel="noreferrer" target="_blank">http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs</a><br>
</blockquote></div>