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