diff options
| author | Jordan Justen <jordan.l.justen@intel.com> | 2014-10-31 22:05:50 +0000 |
|---|---|---|
| committer | jljusten <jljusten@Edk2> | 2014-10-31 22:05:50 +0000 |
| commit | 26830e857906951617d9c75f404139e40e52e62f (patch) | |
| tree | d33324728956acb83ae5d28cdb518bd8e2475ac0 /BaseTools | |
| parent | 489c5c67d0b20cb508429ac7ec9dcc613c12dd72 (diff) | |
| download | edk2-26830e857906951617d9c75f404139e40e52e62f.tar.gz edk2-26830e857906951617d9c75f404139e40e52e62f.tar.bz2 edk2-26830e857906951617d9c75f404139e40e52e62f.zip | |
EDK II Contributions.txt: Update patch format information
Update to show what the patch looks like in email form.
NOTE: This does not modify the wording of the "TianoCore Contribution
Agreement 1.0" section
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16297 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'BaseTools')
| -rw-r--r-- | BaseTools/Contributions.txt | 42 |
1 files changed, 29 insertions, 13 deletions
diff --git a/BaseTools/Contributions.txt b/BaseTools/Contributions.txt index 5dd8a47bad..1985677f4b 100644 --- a/BaseTools/Contributions.txt +++ b/BaseTools/Contributions.txt @@ -34,9 +34,9 @@ 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 =
-=======================================
+=====================================================
+= 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
@@ -44,7 +44,32 @@ and the "Contributed-under" message. == Sample Change Description / Commit Message =
-=== Definitions for sample change description ===
+=== Start of sample patch email message ===
+
+From: Contributor Name <contributor@email.server>
+Subject: [PATCH] CodeModule: Brief-single-line-summary
+
+Full-commit-message
+
+Contributed-under: TianoCore Contribution Agreement 1.0
+Signed-off-by: Contributor Name <contributor@email.server>
+---
+
+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.
@@ -58,15 +83,6 @@ and the "Contributed-under" message. * "Signed-off-by" is the contributor's signature identifying them
by their real/legal name and their email address.
-=== Start of sample change description / commit message ===
-CodeModule: Brief-single-line-summary
-
-Full-commit-message
-
-Contributed-under: TianoCore Contribution Agreement 1.0
-Signed-off-by: Contributor Name <contributor@email.server>
-=== End of sample change description / commit message ===
-
========================================
= TianoCore Contribution Agreement 1.0 =
========================================
|