Re: Community Discussion: General Code and Commit message standards

[Jeremiah Cox <jerecox@microsoft.com>]

In GitHub, adding a link from a PR to an Issue is extremely easy:
https://help.github.com/articles/closing-issues-using-keywords/ 

Use any of the following strings, followed by a number, in a PR description...

close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved

For example:
"Closes #123"

-----Original Message-----
From: edk2-devel <edk2-devel-bounces@lists.01.org> On Behalf Of Kinney, Michael D
Sent: Thursday, October 18, 2018 4:01 PM
To: stephano <stephano.cetola@linux.intel.com>; Andrew Fish <afish@apple.com>; Kinney, Michael D <michael.d.kinney@intel.com>
Cc: Carsey, Jaben <jaben.carsey@intel.com>; edk2-devel@lists.01.org
Subject: Re: [edk2] Community Discussion: General Code and Commit message standards

I would also hope that most (if not all) patches do have an associated BZ.  For either a feature request or a bug fix.

Mike

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org]
> On Behalf Of stephano
> Sent: Thursday, October 18, 2018 10:21 AM
> To: Andrew Fish <afish@apple.com>
> Cc: Carsey, Jaben <jaben.carsey@intel.com>; edk2- devel@lists.01.org
> Subject: Re: [edk2] Community Discussion: General Code and Commit 
> message standards
> 
> On 10/18/2018 6:11 PM, Andrew Fish wrote:> What I've done in the past 
> on a branch based github PR flow is have a naming convention for the 
> branch. For example eng/PR-<Bugzilla #>-<discription>.
> Then we have a
> git hook that looks at the branch name and if it sees a Bugzilla 
> number it inserts the Bugzilla reference in the bottom of every commit 
> message for that branch. The CI also played tricks with the branch 
> names and could update the bug tracker with CI results, and the 
> process status of the bug.
> Interesting. This will make a good point for coming discussions. I'll 
> make a note of it.
> 
> I would hope that most modern workflows have a way to accomplish this 
> in some automated way. Seems like a pretty standard ask.
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists
> .01.org%2Fmailman%2Flistinfo%2Fedk2-devel&amp;data=02%7C01%7Cjerecox%4
> 0microsoft.com%7C9a1bd80da4cd497ff85308d6354d9e4a%7C72f988bf86f141af91
> ab2d7cd011db47%7C1%7C0%7C636755004889706325&amp;sdata=ub18%2BhCBJNCpmL
> x3gh11Aqo59UAZFn0yOczb%2BW2UzvU%3D&amp;reserved=0
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.01.org%2Fmailman%2Flistinfo%2Fedk2-devel&amp;data=02%7C01%7Cjerecox%40microsoft.com%7C9a1bd80da4cd497ff85308d6354d9e4a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636755004889706325&amp;sdata=ub18%2BhCBJNCpmLx3gh11Aqo59UAZFn0yOczb%2BW2UzvU%3D&amp;reserved=0