https://bugzilla.tianocore.org/show_bug.cgi?id=643
Add Readme.md with a brief description of the EDK II open source project along with links to contribution agreement, licenses, and resources. It also provides the Change Description / Commit Message / Patch Email details that were moved out of the Contributions.txt file. Cc: Leif Lindholm <[email protected]> Cc: Andrew Fish <[email protected]> Cc: Jordan Justen <[email protected]> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <[email protected]> --- Readme.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000000..a50a7df5c1 --- /dev/null +++ b/Readme.md @@ -0,0 +1,72 @@ +# EDK II Project + +A modern, feature-rich, cross-platform firmware development environment +for the UEFI and PI specifications from www.uefi.org. + +Contributions to the EDK II open source project are covered by the +[TianoCore Contribution Agreement 1.1](Contributions.txt) + +The majority of the content in the EDK II open source project uses a +[BSD 2-Clause License](LICENSE). The EDK II open source project contains +the following components that are covered by additional licenses: +* [AppPkg/Applications/Python/Python-2.7.2/Tools/pybench](AppPkg/Applications/Python/Python-2.7.2/Tools/pybench/LICENSE) +* [AppPkg/Applications/Python/Python-2.7.2](AppPkg/Applications/Python/Python-2.7.2/LICENSE) +* [AppPkg/Applications/Python/Python-2.7.10](AppPkg/Applications/Python/Python-2.7.10/LICENSE) +* [BaseTools/Source/C/BrotliCompress](BaseTools/Source/C/BrotliCompress/LICENSE) +* [MdeModulePkg/Library/BrotliCustomDecompressLib](MdeModulePkg/Library/BrotliCustomDecompressLib/LICENSE) +* [OvmfPkg/Include/IndustryStandard/Xen](OvmfPkg/License.txt) +* [OvmfPkg/XenBusDxe](OvmfPkg/License.txt) +* [OvmfPkg/XenPvBlkDxe](OvmfPkg/License.txt) +* [CryptoPkg/Library/OpensslLib/openssl](CryptoPkg/Library/OpensslLib/openssl/LICENSE) + +# Resources +* [TianoCore](http://www.tianocore.org) +* [EDK II](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II) +* [Getting Started with EDK II](https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II) +* [Mailing Lists](https://github.com/tianocore/tianocore.github.io/wiki/Mailing-Lists) +* [TianoCore Bugzilla](https://bugzilla.tianocore.org) +* [How To Contribute](https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute) + +# 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 + +``` +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 +``` +## 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`** - a short idenfier for the affected code. For + example `MdePkg`, or `MdeModulePkg/UsbBusDxe`. +* **`Brief-single-line-summary`** - 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`** - the contributor's signature identifying them + by their real/legal name and their email address. -- 2.13.1.windows.2 _______________________________________________ edk2-devel mailing list [email protected] https://lists.01.org/mailman/listinfo/edk2-devel
