Readme.md

   1 # EDK II Project
   2
   3 A modern, feature-rich, cross-platform firmware development environment
   4 for the UEFI and PI specifications from www.uefi.org.
   5
   6 The majority of the content in the EDK II open source project uses a
   7 [BSD-2-Clause Plus Patent License](License.txt).  The EDK II open source project
   8 contains the following components that are covered by additional licenses:
   9 * [AppPkg/Applications/Python/Python-2.7.2/Tools/pybench](AppPkg/Applications/Python/Python-2.7.2/Tools/pybench/LICENSE)
  10 * [AppPkg/Applications/Python/Python-2.7.2](AppPkg/Applications/Python/Python-2.7.2/LICENSE)
  11 * [AppPkg/Applications/Python/Python-2.7.10](AppPkg/Applications/Python/Python-2.7.10/LICENSE)
  12 * [BaseTools/Source/C/BrotliCompress](BaseTools/Source/C/BrotliCompress/LICENSE)
  13 * [MdeModulePkg/Library/BrotliCustomDecompressLib](MdeModulePkg/Library/BrotliCustomDecompressLib/LICENSE)
  14 * [BaseTools/Source/C/LzmaCompress](BaseTools/Source/C/LzmaCompress/LZMA-SDK-README.txt)
  15 * [MdeModulePkg/Library/LzmaCustomDecompressLib](MdeModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)
  16 * [IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/Sdk](IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)
  17 * [BaseTools/Source/C/VfrCompile/Pccts](BaseTools/Source/C/VfrCompile/Pccts/RIGHTS)
  18 * [EdkCompatibilityPkg/Other/Maintained/Tools/Pccts](EdkCompatibilityPkg/Other/Maintained/Tools/Pccts/README)
  19 * [MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma](MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma/README)
  20 * [OvmfPkg](OvmfPkg/License.txt)
  21 * [CryptoPkg/Library/OpensslLib/openssl](CryptoPkg/Library/OpensslLib/openssl/LICENSE)
  22
  23 The EDK II Project is composed of packages.  The maintainers for each package
  24 are listed in [Maintainers.txt](Maintainers.txt).
  25
  26 # Resources
  27 * [TianoCore](http://www.tianocore.org)
  28 * [EDK II](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II)
  29 * [Getting Started with EDK II](https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II)
  30 * [Mailing Lists](https://github.com/tianocore/tianocore.github.io/wiki/Mailing-Lists)
  31 * [TianoCore Bugzilla](https://bugzilla.tianocore.org)
  32 * [How To Contribute](https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute)
  33 * [Release Planning](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Release-Planning)
  34 * [UDK2017](https://github.com/tianocore/edk2/releases/tag/vUDK2017)
  35 * [UDK2018](https://github.com/tianocore/edk2/releases/tag/vUDK2018)
  36 * [edk2-stable201811](https://github.com/tianocore/edk2/releases/tag/edk2-stable201811)
  37
  38 # Code Contributions
  39 To make a contribution to a TianoCore project, follow these steps.
  40 1. Create a change description in the format specified below to
  41    use in the source control commit log.
  42 2. Your commit message must include your `Signed-off-by` signature
  43 3. Submit your code to the TianoCore project using the process
  44    that the project documents on its web page.  If the process is
  45    not documented, then submit the code on development email list
  46    for the project.
  47 4. It is preferred that contributions are submitted using the same
  48    copyright license as the base project. When that is not possible,
  49    then contributions using the following licenses can be accepted:
  50    * BSD (2-clause): http://opensource.org/licenses/BSD-2-Clause
  51    * BSD (3-clause): http://opensource.org/licenses/BSD-3-Clause
  52    * MIT: http://opensource.org/licenses/MIT
  53    * Python-2.0: http://opensource.org/licenses/Python-2.0
  54    * Zlib: http://opensource.org/licenses/Zlib
  55
  56    For documentation:
  57    * FreeBSD Documentation License
  58      https://www.freebsd.org/copyright/freebsd-doc-license.html
  59
  60    Contributions of code put into the public domain can also be
  61    accepted.
  62
  63    Contributions using other licenses might be accepted, but further
  64    review will be required.
  65
  66 # Developer Certificate of Origin
  67
  68 Your change description should use the standard format for a
  69 commit message, and must include your `Signed-off-by` signature.
  70
  71 In order to keep track of who did what, all patches contributed must
  72 include a statement that to the best of the contributor's knowledge
  73 they have the right to contribute it under the specified license.
  74
  75 The test for this is as specified in the [Developer's Certificate of
  76 Origin (DCO) 1.1](https://developercertificate.org/). The contributor
  77 certifies compliance by adding a line saying
  78
  79   Signed-off-by: Developer Name <developer@example.org>
  80
  81 where `Developer Name` is the contributor's real name, and the email
  82 address is one the developer is reachable through at the time of
  83 contributing.
  84
  85 ```
  86 Developer's Certificate of Origin 1.1
  87
  88 By making a contribution to this project, I certify that:
  89
  90 (a) The contribution was created in whole or in part by me and I
  91     have the right to submit it under the open source license
  92     indicated in the file; or
  93
  94 (b) The contribution is based upon previous work that, to the best
  95     of my knowledge, is covered under an appropriate open source
  96     license and I have the right under that license to submit that
  97     work with modifications, whether created in whole or in part
  98     by me, under the same open source license (unless I am
  99     permitted to submit under a different license), as indicated
 100     in the file; or
 101
 102 (c) The contribution was provided directly to me by some other
 103     person who certified (a), (b) or (c) and I have not modified
 104     it.
 105
 106 (d) I understand and agree that this project and the contribution
 107     are public and that a record of the contribution (including all
 108     personal information I submit with it, including my sign-off) is
 109     maintained indefinitely and may be redistributed consistent with
 110     this project or the open source license(s) involved.
 111 ```
 112
 113 # Sample Change Description / Commit Message
 114
 115 ```
 116 From: Contributor Name <contributor@example.com>
 117 Subject: [Repository/Branch PATCH] Pkg-Module: Brief-single-line-summary
 118
 119 Full-commit-message
 120
 121 Signed-off-by: Contributor Name <contributor@example.com>
 122 ```
 123
 124 ## Notes for sample patch email
 125
 126 * The first line of commit message is taken from the email's subject
 127   line following `[Repository/Branch PATCH]`. The remaining portion of the
 128   commit message is the email's content.
 129 * `git format-patch` is one way to create this format
 130
 131 ## Definitions for sample patch email
 132
 133 * `Repository` is the identifier of the repository the patch applies.
 134   This identifier should only be provided for repositories other than
 135   `edk2`. For example `edk2-BuildSpecification` or `staging`.
 136 * `Branch` is the identifier of the branch the patch applies. This
 137   identifier should only be provided for branches other than `edk2/master`.
 138   For example `edk2/UDK2015`, `edk2-BuildSpecification/release/1.27`, or
 139   `staging/edk2-test`.
 140 * `Module` is a short identifier for the affected code or documentation. For
 141   example `MdePkg`, `MdeModulePkg/UsbBusDxe`, `Introduction`, or
 142   `EDK II INF File Format`.
 143 * `Brief-single-line-summary` is a short summary of the change.
 144 * The entire first line should be less than ~70 characters.
 145 * `Full-commit-message` a verbose multiple line comment describing
 146   the change.  Each line should be less than ~70 characters.
 147 * `Signed-off-by` is the contributor's signature identifying them
 148   by their real/legal name and their email address.