EDK II Contributions.txt: Update patch format information

[mirror_edk2.git] / PcAtChipsetPkg / Contributions.txt

diff --git a/PcAtChipsetPkg/Contributions.txt b/PcAtChipsetPkg/Contributions.txt
index 5dd8a47bad9d882b0dca4d9152156a385f348c27..1985677f4b54c64c993b1976b95caa2b97b94d90 100644 (file)
--- a/PcAtChipsetPkg/Contributions.txt
+++ b/PcAtChipsetPkg/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\r
    review will be required.\r
 \r
    Contributions using other licenses might be accepted, but further\r
    review will be required.\r
 \r

-=======================================\r
-= Change Description / Commit Message =\r
-=======================================\r
+=====================================================\r
+= Change Description / Commit Message / Patch Email =\r
+=====================================================\r

 \r
 Your change description should use the standard format for a\r
 commit message, and must include your "Signed-off-by" signature\r
 \r
 Your change description should use the standard format for a\r
 commit message, and must include your "Signed-off-by" signature\r


@@ -44,7 +44,32 @@ and the "Contributed-under" message.
 \r
 == Sample Change Description / Commit Message =\r
 \r
 \r
 == Sample Change Description / Commit Message =\r
 \r

-=== Definitions for sample change description ===\r
+=== Start of sample patch email message ===\r
+\r
+From: Contributor Name <contributor@email.server>\r
+Subject: [PATCH] CodeModule: Brief-single-line-summary\r
+\r
+Full-commit-message\r
+\r
+Contributed-under: TianoCore Contribution Agreement 1.0\r
+Signed-off-by: Contributor Name <contributor@email.server>\r
+---\r
+\r
+An extra message for the patch email which will not be considered part\r
+of the commit message can be added here.\r
+\r
+Patch content inline or attached\r
+\r
+=== End of sample patch email message ===\r
+\r
+=== Notes for sample patch email ===\r
+\r
+* The first line of commit message is taken from the email's subject\r
+  line following [PATCH]. The remaining portion of the commit message\r
+  is the email's content until the '---' line.\r
+* git format-patch is one way to create this format\r
+\r
+=== Definitions for sample patch email ===\r

 \r
 * "CodeModule" is a short idenfier for the affected code.  For\r
   example MdePkg, or MdeModulePkg UsbBusDxe.\r
 \r
 * "CodeModule" is a short idenfier for the affected code.  For\r
   example MdePkg, or MdeModulePkg UsbBusDxe.\r


@@ -58,15 +83,6 @@ and the "Contributed-under" message.
 * "Signed-off-by" is the contributor's signature identifying them\r
   by their real/legal name and their email address.\r
 \r
 * "Signed-off-by" is the contributor's signature identifying them\r
   by their real/legal name and their email address.\r
 \r

-=== Start of sample change description / commit message ===\r
-CodeModule: Brief-single-line-summary\r
-\r
-Full-commit-message\r
-\r
-Contributed-under: TianoCore Contribution Agreement 1.0\r
-Signed-off-by: Contributor Name <contributor@email.server>\r
-=== End of sample change description / commit message ===\r
-\r

 ========================================\r
 = TianoCore Contribution Agreement 1.0 =\r
 ========================================\r
 ========================================\r
 = TianoCore Contribution Agreement 1.0 =\r
 ========================================\r