From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id A76592095D2AA for ; Wed, 19 Jul 2017 10:37:11 -0700 (PDT) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 19 Jul 2017 10:39:06 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,381,1496127600"; d="scan'208";a="994812483" Received: from jpenaask-mobl1.amr.corp.intel.com (HELO localhost) ([10.254.118.75]) by orsmga003.jf.intel.com with ESMTP; 19 Jul 2017 10:39:05 -0700 MIME-Version: 1.0 To: "Kinney, Michael D" , "edk2-devel@lists.01.org" Message-ID: <150048594561.22073.6315011812385006709@jljusten-skl> From: Jordan Justen In-Reply-To: Cc: Leif Lindholm , Andrew Fish References: <20170718211701.37196-1-michael.d.kinney@intel.com> <20170718211701.37196-5-michael.d.kinney@intel.com> <150042123598.7417.658078738092802916@jljusten-skl> User-Agent: alot/0.5.1 Date: Wed, 19 Jul 2017 10:39:05 -0700 Subject: Re: [Patch 4/6] edk2: Remove commit message details from Contributions.txt X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 19 Jul 2017 17:37:11 -0000 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable On 2017-07-19 08:54:42, Kinney, Michael D wrote: > Jordan, > = > The goal is to use the same agreement for code and > documentation. The text I removed only applies to code > contributions. Document contributions have slightly > different commit message requirements. What is different about the commit message for documentation? We should document what is different about the process for documents rather than dropping the information for code contributions. I also don't know why we can't have different text at the top of Contributions.txt in code vs. documentation repositories, if we wanted to. I don't think we should do this, but if you don't think it's feasible to document the process for both code and documentation in a single file, then maybe this could work. Once again, I think documenting the Contributed-under and Signed-off-by commit message requirements in this file is pretty important. -Jordan > Contributions.txt in the tianocore-docs repositories > do not have this section, and the details on the commit > messages are in the RFC and Wiki for documentation. > = > I will add the initial version of Readme.md with this = > the code commit message details to this patch series, > so the information is retained. > = > Mike > = > > -----Original Message----- > > From: Justen, Jordan L > > Sent: Tuesday, July 18, 2017 4:41 PM > > To: Kinney, Michael D ; edk2- > > devel@lists.01.org > > Cc: Leif Lindholm ; Andrew Fish > > > > Subject: Re: [Patch 4/6] edk2: Remove commit message details from > > Contributions.txt > > = > > On 2017-07-18 14:16:59, Michael D Kinney wrote: > > > https://bugzilla.tianocore.org/show_bug.cgi?id=3D629 > > > > > > Remove the change description, commit message, and > > > patch email section from Contributions.txt. This > > > section is not part of the TianoCore Contribution > > > Agreement. The information is very important and is > > > provided on the TianoCore web site and wiki and will > > > be added to Readme.md in the root of the edk2 > > > repository. > > = > > I don't think this should be removed. If the readme is added at a > > later time, then perhaps we could consider moving it. > > = > > This information is specifically about contributing to the EDK II > > project, so why isn't Contributions.txt a better place than a > > generic > > readme? > > = > > Some parts of this are closely tied to the contribution agreement > > process. For example, the text: '"Signed-off-by" is the > > contributor's > > signature identifying them by their real/legal name and their > > email > > address.' It seems better to have this nearby the contribution > > agreement text. > > = > > -Jordan > > = > > > > > > Cc: Leif Lindholm > > > Cc: Andrew Fish > > > Cc: Jordan Justen > > > Contributed-under: TianoCore Contribution Agreement 1.1 > > > Signed-off-by: Michael D Kinney > > > --- > > > Contributions.txt | 49 --------------------------------------- > > ---------- > > > 1 file changed, 49 deletions(-) > > > > > > diff --git a/Contributions.txt b/Contributions.txt > > > index f87cbd73c6..06c60d8e17 100644 > > > --- a/Contributions.txt > > > +++ b/Contributions.txt > > > @@ -34,55 +34,6 @@ To make a contribution to a TianoCore > > project, follow these steps. > > > Contributions using other licenses might be accepted, but > > further > > > review will be required. > > > > > > -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D > > > -=3D Change Description / Commit Message / Patch Email =3D > > > -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D > > > - > > > -Your change description should use the standard format for a > > > -commit message, and must include your "Signed-off-by" > > signature > > > -and the "Contributed-under" message. > > > - > > > -=3D=3D Sample Change Description / Commit Message =3D > > > - > > > -=3D=3D=3D Start of sample patch email message =3D=3D=3D > > > - > > > -From: Contributor Name > > > -Subject: [PATCH] CodeModule: Brief-single-line-summary > > > - > > > -Full-commit-message > > > - > > > -Contributed-under: TianoCore Contribution Agreement 1.0 > > > -Signed-off-by: Contributor Name > > > ---- > > > - > > > -An extra message for the patch email which will not be > > considered part > > > -of the commit message can be added here. > > > - > > > -Patch content inline or attached > > > - > > > -=3D=3D=3D End of sample patch email message =3D=3D=3D > > > - > > > -=3D=3D=3D Notes for sample patch email =3D=3D=3D > > > - > > > -* The first line of commit message is taken from the email's > > subject > > > - line following [PATCH]. The remaining portion of the commit > > message > > > - is the email's content until the '---' line. > > > -* git format-patch is one way to create this format > > > - > > > -=3D=3D=3D Definitions for sample patch email =3D=3D=3D > > > - > > > -* "CodeModule" is a short idenfier for the affected code. For > > > - example MdePkg, or MdeModulePkg UsbBusDxe. > > > -* "Brief-single-line-summary" is a short summary of the > > change. > > > -* The entire first line should be less than ~70 characters. > > > -* "Full-commit-message" a verbose multiple line comment > > describing > > > - the change. Each line should be less than ~70 characters. > > > -* "Contributed-under" explicitely states that the contribution > > is > > > - made under the terms of the contribtion agreement. This > > > - agreement is included below in this document. > > > -* "Signed-off-by" is the contributor's signature identifying > > them > > > - by their real/legal name and their email address. > > > - > > > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > > > =3D TianoCore Contribution Agreement 1.0 =3D > > > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > > > -- > > > 2.13.1.windows.2 > > >