MR template text
Richard Eisenberg
rae at richarde.dev
Tue Feb 23 21:19:46 UTC 2021
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:
> On Feb 23, 2021, at 11:14 AM, Simon Peyton Jones via ghc-devs <ghc-devs at haskell.org> wrote:
>
> 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.
If you are not ready for wide review, please start the MR name with the prefix "WIP:", for "work in progress".
>
> For general style guidance see
> https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style <https://gitlab.haskell.org/ghc/ghc/wikis/commentary/coding-style>
Richard
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-devs/attachments/20210223/cf5dcba6/attachment.html>
More information about the ghc-devs
mailing list