]>
Commit | Line | Data |
---|---|---|
cd9cbcf1 JJ |
1 | \r |
2 | ======================\r | |
3 | = Code Contributions =\r | |
4 | ======================\r | |
5 | \r | |
6 | To make a contribution to a TianoCore project, follow these steps.\r | |
7 | 1. Create a change description in the format specified below to\r | |
8 | use in the source control commit log.\r | |
9 | 2. Your commit message must include your "Signed-off-by" signature,\r | |
10 | and "Contributed-under" message.\r | |
11 | 3. Your "Contributed-under" message explicitly states that the\r | |
12 | contribution is made under the terms of the specified\r | |
13 | contribution agreement. Your "Contributed-under" message\r | |
14 | must include the name of contribution agreement and version.\r | |
15 | For example: Contributed-under: TianoCore Contribution Agreement 1.0\r | |
16 | The "TianoCore Contribution Agreement" is included below in\r | |
17 | this document.\r | |
18 | 4. Submit your code to the TianoCore project using the process\r | |
19 | that the project documents on its web page. If the process is\r | |
20 | not documented, then submit the code on development email list\r | |
21 | for the project.\r | |
22 | 5. It is preferred that contributions are submitted using the same\r | |
23 | copyright license as the base project. When that is not possible,\r | |
24 | then contributions using the following licenses can be accepted:\r | |
25 | * BSD (2-clause): http://opensource.org/licenses/BSD-2-Clause\r | |
26 | * BSD (3-clause): http://opensource.org/licenses/BSD-3-Clause\r | |
27 | * MIT: http://opensource.org/licenses/MIT\r | |
28 | * Python-2.0: http://opensource.org/licenses/Python-2.0\r | |
29 | * Zlib: http://opensource.org/licenses/Zlib\r | |
30 | \r | |
31 | Contributions of code put into the public domain can also be\r | |
32 | accepted.\r | |
33 | \r | |
34 | Contributions using other licenses might be accepted, but further\r | |
35 | review will be required.\r | |
36 | \r | |
37 | =====================================================\r | |
38 | = Change Description / Commit Message / Patch Email =\r | |
39 | =====================================================\r | |
40 | \r | |
41 | Your change description should use the standard format for a\r | |
42 | commit message, and must include your "Signed-off-by" signature\r | |
43 | and the "Contributed-under" message.\r | |
44 | \r | |
45 | == Sample Change Description / Commit Message =\r | |
46 | \r | |
47 | === Start of sample patch email message ===\r | |
48 | \r | |
3f3c4895 | 49 | From: Contributor Name <contributor@example.com>\r |
cd9cbcf1 JJ |
50 | Subject: [PATCH] CodeModule: Brief-single-line-summary\r |
51 | \r | |
52 | Full-commit-message\r | |
53 | \r | |
54 | Contributed-under: TianoCore Contribution Agreement 1.0\r | |
3f3c4895 | 55 | Signed-off-by: Contributor Name <contributor@example.com>\r |
cd9cbcf1 JJ |
56 | ---\r |
57 | \r | |
58 | An extra message for the patch email which will not be considered part\r | |
59 | of the commit message can be added here.\r | |
60 | \r | |
61 | Patch content inline or attached\r | |
62 | \r | |
63 | === End of sample patch email message ===\r | |
64 | \r | |
65 | === Notes for sample patch email ===\r | |
66 | \r | |
67 | * The first line of commit message is taken from the email's subject\r | |
68 | line following [PATCH]. The remaining portion of the commit message\r | |
69 | is the email's content until the '---' line.\r | |
70 | * git format-patch is one way to create this format\r | |
71 | \r | |
72 | === Definitions for sample patch email ===\r | |
73 | \r | |
74 | * "CodeModule" is a short idenfier for the affected code. For\r | |
75 | example MdePkg, or MdeModulePkg UsbBusDxe.\r | |
76 | * "Brief-single-line-summary" is a short summary of the change.\r | |
77 | * The entire first line should be less than ~70 characters.\r | |
78 | * "Full-commit-message" a verbose multiple line comment describing\r | |
79 | the change. Each line should be less than ~70 characters.\r | |
80 | * "Contributed-under" explicitely states that the contribution is\r | |
81 | made under the terms of the contribtion agreement. This\r | |
82 | agreement is included below in this document.\r | |
83 | * "Signed-off-by" is the contributor's signature identifying them\r | |
84 | by their real/legal name and their email address.\r | |
85 | \r | |
86 | ========================================\r | |
87 | = TianoCore Contribution Agreement 1.0 =\r | |
88 | ========================================\r | |
89 | \r | |
90 | INTEL CORPORATION ("INTEL") MAKES AVAILABLE SOFTWARE, DOCUMENTATION,\r | |
91 | INFORMATION AND/OR OTHER MATERIALS FOR USE IN THE TIANOCORE OPEN SOURCE\r | |
92 | PROJECT (COLLECTIVELY "CONTENT"). USE OF THE CONTENT IS GOVERNED BY THE\r | |
93 | TERMS AND CONDITIONS OF THIS AGREEMENT BETWEEN YOU AND INTEL AND/OR THE\r | |
94 | TERMS AND CONDITIONS OF LICENSE AGREEMENTS OR NOTICES INDICATED OR\r | |
95 | REFERENCED BELOW. BY USING THE CONTENT, YOU AGREE THAT YOUR USE OF THE\r | |
96 | CONTENT IS GOVERNED BY THIS AGREEMENT AND/OR THE TERMS AND CONDITIONS\r | |
97 | OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED\r | |
98 | BELOW. IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS\r | |
99 | AGREEMENT AND THE TERMS AND CONDITIONS OF ANY APPLICABLE LICENSE\r | |
100 | AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW, THEN YOU MAY NOT\r | |
101 | USE THE CONTENT.\r | |
102 | \r | |
103 | Unless otherwise indicated, all Content made available on the TianoCore\r | |
104 | site is provided to you under the terms and conditions of the BSD\r | |
105 | License ("BSD"). A copy of the BSD License is available at\r | |
106 | http://opensource.org/licenses/bsd-license.php\r | |
107 | or when applicable, in the associated License.txt file.\r | |
108 | \r | |
109 | Certain other content may be made available under other licenses as\r | |
110 | indicated in or with such Content. (For example, in a License.txt file.)\r | |
111 | \r | |
112 | You accept and agree to the following terms and conditions for Your\r | |
113 | present and future Contributions submitted to TianoCore site. Except\r | |
114 | for the license granted to Intel hereunder, You reserve all right,\r | |
115 | title, and interest in and to Your Contributions.\r | |
116 | \r | |
117 | == SECTION 1: Definitions ==\r | |
118 | * "You" or "Contributor" shall mean the copyright owner or legal\r | |
119 | entity authorized by the copyright owner that is making a\r | |
120 | Contribution hereunder. All other entities that control, are\r | |
121 | controlled by, or are under common control with that entity are\r | |
122 | considered to be a single Contributor. For the purposes of this\r | |
123 | definition, "control" means (i) the power, direct or indirect, to\r | |
124 | cause the direction or management of such entity, whether by\r | |
125 | contract or otherwise, or (ii) ownership of fifty percent (50%)\r | |
126 | or more of the outstanding shares, or (iii) beneficial ownership\r | |
127 | of such entity.\r | |
128 | * "Contribution" shall mean any original work of authorship,\r | |
129 | including any modifications or additions to an existing work,\r | |
130 | that is intentionally submitted by You to the TinaoCore site for\r | |
131 | inclusion in, or documentation of, any of the Content. For the\r | |
132 | purposes of this definition, "submitted" means any form of\r | |
133 | electronic, verbal, or written communication sent to the\r | |
134 | TianoCore site or its representatives, including but not limited\r | |
135 | to communication on electronic mailing lists, source code\r | |
136 | control systems, and issue tracking systems that are managed by,\r | |
137 | or on behalf of, the TianoCore site for the purpose of\r | |
138 | discussing and improving the Content, but excluding\r | |
139 | communication that is conspicuously marked or otherwise\r | |
140 | designated in writing by You as "Not a Contribution."\r | |
141 | \r | |
142 | == SECTION 2: License for Contributions ==\r | |
143 | * Contributor hereby agrees that redistribution and use of the\r | |
144 | Contribution in source and binary forms, with or without\r | |
145 | modification, are permitted provided that the following\r | |
146 | conditions are met:\r | |
147 | ** Redistributions of source code must retain the Contributor's\r | |
148 | copyright notice, this list of conditions and the following\r | |
149 | disclaimer.\r | |
150 | ** Redistributions in binary form must reproduce the Contributor's\r | |
151 | copyright notice, this list of conditions and the following\r | |
152 | disclaimer in the documentation and/or other materials provided\r | |
153 | with the distribution.\r | |
154 | * Disclaimer. None of the names of Contributor, Intel, or the names\r | |
155 | of their respective contributors may be used to endorse or\r | |
156 | promote products derived from this software without specific\r | |
157 | prior written permission.\r | |
158 | * Contributor grants a license (with the right to sublicense) under\r | |
159 | claims of Contributor's patents that Contributor can license that\r | |
160 | are infringed by the Contribution (as delivered by Contributor) to\r | |
161 | make, use, distribute, sell, offer for sale, and import the\r | |
162 | Contribution and derivative works thereof solely to the minimum\r | |
163 | extent necessary for licensee to exercise the granted copyright\r | |
164 | license; this patent license applies solely to those portions of\r | |
165 | the Contribution that are unmodified. No hardware per se is\r | |
166 | licensed.\r | |
167 | * EXCEPT AS EXPRESSLY SET FORTH IN SECTION 3 BELOW, THE\r | |
168 | CONTRIBUTION IS PROVIDED BY THE CONTRIBUTOR "AS IS" AND ANY\r | |
169 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,\r | |
170 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\r | |
171 | PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\r | |
172 | CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r | |
173 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r | |
174 | NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r | |
175 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r | |
176 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r | |
177 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\r | |
178 | OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE\r | |
179 | CONTRIBUTION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH\r | |
180 | DAMAGE.\r | |
181 | \r | |
182 | == SECTION 3: Representations ==\r | |
183 | * You represent that You are legally entitled to grant the above\r | |
184 | license. If your employer(s) has rights to intellectual property\r | |
185 | that You create that includes Your Contributions, You represent\r | |
186 | that You have received permission to make Contributions on behalf\r | |
187 | of that employer, that Your employer has waived such rights for\r | |
188 | Your Contributions.\r | |
189 | * You represent that each of Your Contributions is Your original\r | |
190 | creation (see Section 4 for submissions on behalf of others).\r | |
191 | You represent that Your Contribution submissions include complete\r | |
192 | details of any third-party license or other restriction\r | |
193 | (including, but not limited to, related patents and trademarks)\r | |
194 | of which You are personally aware and which are associated with\r | |
195 | any part of Your Contributions.\r | |
196 | \r | |
197 | == SECTION 4: Third Party Contributions ==\r | |
198 | * Should You wish to submit work that is not Your original creation,\r | |
199 | You may submit it to TianoCore site separately from any\r | |
200 | Contribution, identifying the complete details of its source\r | |
201 | and of any license or other restriction (including, but not\r | |
202 | limited to, related patents, trademarks, and license agreements)\r | |
203 | of which You are personally aware, and conspicuously marking the\r | |
204 | work as "Submitted on behalf of a third-party: [named here]".\r | |
205 | \r | |
206 | == SECTION 5: Miscellaneous ==\r | |
207 | * Applicable Laws. Any claims arising under or relating to this\r | |
208 | Agreement shall be governed by the internal substantive laws of\r | |
209 | the State of Delaware or federal courts located in Delaware,\r | |
210 | without regard to principles of conflict of laws.\r | |
211 | * Language. This Agreement is in the English language only, which\r | |
212 | language shall be controlling in all respects, and all versions\r | |
213 | of this Agreement in any other language shall be for accommodation\r | |
214 | only and shall not be binding. All communications and notices made\r | |
215 | or given pursuant to this Agreement, and all documentation and\r | |
216 | support to be provided, unless otherwise noted, shall be in the\r | |
217 | English language.\r | |
218 | \r |