MR titles

[Simon Peyton Jones]

This is part of our contributing guide at work

Do you have other advice from your contributing guide that we could learn from?

Simon

From: chessai . <chessai1996 at gmail.com>
Sent: 08 May 2019 12:29
To: Simon Peyton Jones <simonpj at microsoft.com>
Cc: GHC developers <ghc-devs at haskell.org>
Subject: Re: MR titles

I agree that this is the way to go. This is part of our contributing guide at work, for the reasons you mentioned. Additionally it helps avoid the need to read the MR's contents (comments/code) before going into it, since reading relevant tickets is almost always something you want to do.

Thanks
On Wed, May 8, 2019, 4:51 AM Simon Peyton Jones via ghc-devs <ghc-devs at haskell.org<mailto:ghc-devs at haskell.org>> wrote:
Friends
In this MR<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgitlab.haskell.org%2Fghc%2Fghc%2Fmerge_requests%2F908&data=01%7C01%7Csimonpj%40microsoft.com%7C487f4479e1cc4c11384e08d6d3a858f5%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=jGPjqW1tk3nTbn5AELGYnYNhu04z%2BXDKQlpf9Y%2F9zMU%3D&reserved=0>, Vlad includes the number of the ticket it fixes in the title of the MR.
That is so helpful:

  *   It links the MR back to the issue
  *   And does so in large font (screen shot below)
  *   And the link is clickable, even in the title.
I suggest we document this in our GHC-best-practice guide, and get everyone to do it.
Would you agree
Simon

[cid:image001.jpg at 01D50583.988DEB70]
_______________________________________________
ghc-devs mailing list
ghc-devs at haskell.org<mailto:ghc-devs at haskell.org>
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs<https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmail.haskell.org%2Fcgi-bin%2Fmailman%2Flistinfo%2Fghc-devs&data=01%7C01%7Csimonpj%40microsoft.com%7C487f4479e1cc4c11384e08d6d3a858f5%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=vntGd9uH05b57uM%2BFV%2FD%2FDUh9cNCfswCexFevjwxphg%3D&reserved=0>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-devs/attachments/20190508/617ea678/attachment.html>