Re: [Patch 4/6] edk2: Remove commit message details from Contributions.txt

[Jordan Justen <jordan.l.justen@intel.com>]

On 2017-07-18 14:16:59, Michael D Kinney wrote:
> https://bugzilla.tianocore.org/show_bug.cgi?id=629
> 
> 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 <leif.lindholm@linaro.org>
> Cc: Andrew Fish <afish@apple.com>
> Cc: Jordan Justen <jordan.l.justen@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> ---
>  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.
>  
> -=====================================================
> -= Change Description / Commit Message / Patch Email =
> -=====================================================
> -
> -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.
> -
> -== Sample Change Description / Commit Message =
> -
> -=== Start of sample patch email message ===
> -
> -From: Contributor Name <contributor@example.com>
> -Subject: [PATCH] CodeModule: Brief-single-line-summary
> -
> -Full-commit-message
> -
> -Contributed-under: TianoCore Contribution Agreement 1.0
> -Signed-off-by: Contributor Name <contributor@example.com>
> ----
> -
> -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
> -
> -=== End of sample patch email message ===
> -
> -=== Notes for sample patch email ===
> -
> -* 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
> -
> -=== Definitions for sample patch email ===
> -
> -* "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.
> -
>  ========================================
>  = TianoCore Contribution Agreement 1.0 =
>  ========================================
> -- 
> 2.13.1.windows.2
>