forked from tianocore/edk2
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 <[email protected]>
Reviewed-by: Jaben Carsey <[email protected]>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16297 6f19259b-4bc3-4df7-8a09-765794883524- Loading branch information
Showing
31 changed files
with
899 additions
and
403 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,17 +34,42 @@ 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 | ||
| and the "Contributed-under" message. | ||
|
|
||
| == Sample Change Description / Commit Message = | ||
|
|
||
| === Definitions for sample change description === | ||
| === Start of sample patch email message === | ||
|
|
||
| From: Contributor Name <[email protected]> | ||
| Subject: [PATCH] CodeModule: Brief-single-line-summary | ||
|
|
||
| Full-commit-message | ||
|
|
||
| Contributed-under: TianoCore Contribution Agreement 1.0 | ||
| Signed-off-by: Contributor Name <[email protected]> | ||
| --- | ||
|
|
||
| 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 <[email protected]> | ||
| === End of sample change description / commit message === | ||
|
|
||
| ======================================== | ||
| = TianoCore Contribution Agreement 1.0 = | ||
| ======================================== | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,17 +34,42 @@ 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 | ||
| and the "Contributed-under" message. | ||
|
|
||
| == Sample Change Description / Commit Message = | ||
|
|
||
| === Definitions for sample change description === | ||
| === Start of sample patch email message === | ||
|
|
||
| From: Contributor Name <[email protected]> | ||
| Subject: [PATCH] CodeModule: Brief-single-line-summary | ||
|
|
||
| Full-commit-message | ||
|
|
||
| Contributed-under: TianoCore Contribution Agreement 1.0 | ||
| Signed-off-by: Contributor Name <[email protected]> | ||
| --- | ||
|
|
||
| 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 <[email protected]> | ||
| === End of sample change description / commit message === | ||
|
|
||
| ======================================== | ||
| = TianoCore Contribution Agreement 1.0 = | ||
| ======================================== | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,17 +34,42 @@ 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 | ||
| and the "Contributed-under" message. | ||
|
|
||
| == Sample Change Description / Commit Message = | ||
|
|
||
| === Definitions for sample change description === | ||
| === Start of sample patch email message === | ||
|
|
||
| From: Contributor Name <[email protected]> | ||
| Subject: [PATCH] CodeModule: Brief-single-line-summary | ||
|
|
||
| Full-commit-message | ||
|
|
||
| Contributed-under: TianoCore Contribution Agreement 1.0 | ||
| Signed-off-by: Contributor Name <[email protected]> | ||
| --- | ||
|
|
||
| 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 <[email protected]> | ||
| === End of sample change description / commit message === | ||
|
|
||
| ======================================== | ||
| = TianoCore Contribution Agreement 1.0 = | ||
| ======================================== | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,17 +34,42 @@ 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 | ||
| and the "Contributed-under" message. | ||
|
|
||
| == Sample Change Description / Commit Message = | ||
|
|
||
| === Definitions for sample change description === | ||
| === Start of sample patch email message === | ||
|
|
||
| From: Contributor Name <[email protected]> | ||
| Subject: [PATCH] CodeModule: Brief-single-line-summary | ||
|
|
||
| Full-commit-message | ||
|
|
||
| Contributed-under: TianoCore Contribution Agreement 1.0 | ||
| Signed-off-by: Contributor Name <[email protected]> | ||
| --- | ||
|
|
||
| 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 <[email protected]> | ||
| === End of sample change description / commit message === | ||
|
|
||
| ======================================== | ||
| = TianoCore Contribution Agreement 1.0 = | ||
| ======================================== | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,17 +34,42 @@ 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 | ||
| and the "Contributed-under" message. | ||
|
|
||
| == Sample Change Description / Commit Message = | ||
|
|
||
| === Definitions for sample change description === | ||
| === Start of sample patch email message === | ||
|
|
||
| From: Contributor Name <[email protected]> | ||
| Subject: [PATCH] CodeModule: Brief-single-line-summary | ||
|
|
||
| Full-commit-message | ||
|
|
||
| Contributed-under: TianoCore Contribution Agreement 1.0 | ||
| Signed-off-by: Contributor Name <[email protected]> | ||
| --- | ||
|
|
||
| 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 <[email protected]> | ||
| === End of sample change description / commit message === | ||
|
|
||
| ======================================== | ||
| = TianoCore Contribution Agreement 1.0 = | ||
| ======================================== | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,17 +34,42 @@ 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 | ||
| and the "Contributed-under" message. | ||
|
|
||
| == Sample Change Description / Commit Message = | ||
|
|
||
| === Definitions for sample change description === | ||
| === Start of sample patch email message === | ||
|
|
||
| From: Contributor Name <[email protected]> | ||
| Subject: [PATCH] CodeModule: Brief-single-line-summary | ||
|
|
||
| Full-commit-message | ||
|
|
||
| Contributed-under: TianoCore Contribution Agreement 1.0 | ||
| Signed-off-by: Contributor Name <[email protected]> | ||
| --- | ||
|
|
||
| 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 <[email protected]> | ||
| === End of sample change description / commit message === | ||
|
|
||
| ======================================== | ||
| = TianoCore Contribution Agreement 1.0 = | ||
| ======================================== | ||
|
|
||
Oops, something went wrong.