Re: [edk2] Community Discussion: General Code and Commit message standards
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 On Behalf Of Kinney, Michael D Sent: Thursday, October 18, 2018 4:01 PM To: stephano ; Andrew Fish ; Kinney, Michael D Cc: Carsey, Jaben ; 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-boun...@lists.01.org] > On Behalf Of stephano > Sent: Thursday, October 18, 2018 10:21 AM > To: Andrew Fish > Cc: Carsey, Jaben ; edk2- de...@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--. > 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-develdata=02%7C01%7Cjerecox%4 > 0microsoft.com%7C9a1bd80da4cd497ff85308d6354d9e4a%7C72f988bf86f141af91 > ab2d7cd011db47%7C1%7C0%7C636755004889706325sdata=ub18%2BhCBJNCpmL > x3gh11Aqo59UAZFn0yOczb%2BW2UzvU%3Dreserved=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-develdata=02%7C01%7Cjerecox%40microsoft.com%7C9a1bd80da4cd497ff85308d6354d9e4a%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636755004889706325sdata=ub18%2BhCBJNCpmLx3gh11Aqo59UAZFn0yOczb%2BW2UzvU%3Dreserved=0 ___ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
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-boun...@lists.01.org] > On Behalf Of stephano > Sent: Thursday, October 18, 2018 10:21 AM > To: Andrew Fish > Cc: Carsey, Jaben ; edk2- > de...@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--. > 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://lists.01.org/mailman/listinfo/edk2-devel ___ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
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--. 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://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] Community Discussion: General Code and Commit message standards
> On Oct 18, 2018, at 9:43 AM, stephano wrote: > > On 10/18/2018 4:49 PM, Andrew Fish wrote: >>> On Oct 18, 2018, at 7:22 AM, Carsey, Jaben wrote: >>> >>> I would like to know when a patch fixes a BZ. Subject/body I have less >>> strong opinion about. >>> >> +1 >> Thanks, >> Andrew Fish > This is always a point of contention with mailing list style patch-workflows > in my experience. I know some groups have had success with patchwork, but I > am hoping whatever workflow we choose will support this idea. > S, 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--. 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. Thanks, Andrew Fish > I'll add this to our list of features for our upcoming discussions. Thanks > guys! > > --S > ___ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel ___ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] Community Discussion: General Code and Commit message standards
On 10/18/2018 4:49 PM, Andrew Fish wrote: On Oct 18, 2018, at 7:22 AM, Carsey, Jaben wrote: I would like to know when a patch fixes a BZ. Subject/body I have less strong opinion about. +1 Thanks, Andrew Fish This is always a point of contention with mailing list style patch-workflows in my experience. I know some groups have had success with patchwork, but I am hoping whatever workflow we choose will support this idea. I'll add this to our list of features for our upcoming discussions. Thanks guys! --S ___ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] Community Discussion: General Code and Commit message standards
> On Oct 18, 2018, at 7:22 AM, Carsey, Jaben wrote: > > I would like to know when a patch fixes a BZ. Subject/body I have less strong > opinion about. > +1 Thanks, Andrew Fish >> -Original Message- >> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of >> stephano >> Sent: Thursday, October 18, 2018 2:13 AM >> To: edk2-devel@lists.01.org >> Subject: [edk2] Community Discussion: General Code and Commit message >> standards >> >> This discussion was tabled as it will probably be its own meeting rather >> than part of our general discussions this month. >> >> Recently on the list Laszlo and Star agreed that we should be adding the >> CVE to the subject of any patch that fixes a CVE. I will be documenting >> this in the wiki as well as Contributions.txt. >> >> This thread is meant as a chance to begin discussions before we meet to >> formally review the topic. It will give folks a chance to research any >> known pain points or suggested solutions. >> >> Cheers, >> Stephano >> ___ >> edk2-devel mailing list >> edk2-devel@lists.01.org >> https://lists.01.org/mailman/listinfo/edk2-devel > ___ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel ___ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] Community Discussion: General Code and Commit message standards
I would like to know when a patch fixes a BZ. Subject/body I have less strong opinion about. > -Original Message- > From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of > stephano > Sent: Thursday, October 18, 2018 2:13 AM > To: edk2-devel@lists.01.org > Subject: [edk2] Community Discussion: General Code and Commit message > standards > > This discussion was tabled as it will probably be its own meeting rather > than part of our general discussions this month. > > Recently on the list Laszlo and Star agreed that we should be adding the > CVE to the subject of any patch that fixes a CVE. I will be documenting > this in the wiki as well as Contributions.txt. > > This thread is meant as a chance to begin discussions before we meet to > formally review the topic. It will give folks a chance to research any > known pain points or suggested solutions. > > Cheers, > Stephano > ___ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel ___ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
[edk2] Community Discussion: General Code and Commit message standards
This discussion was tabled as it will probably be its own meeting rather than part of our general discussions this month. Recently on the list Laszlo and Star agreed that we should be adding the CVE to the subject of any patch that fixes a CVE. I will be documenting this in the wiki as well as Contributions.txt. This thread is meant as a chance to begin discussions before we meet to formally review the topic. It will give folks a chance to research any known pain points or suggested solutions. Cheers, Stephano ___ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
