Skip to content

Commit e9f1832

Browse files
authored
Merge pull request eclipse-omr#7299 from 0xdaryl/contrib
Improve ECA documentation in CONTRIBUTING.md
2 parents 974bec3 + ffd5489 commit e9f1832

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -150,19 +150,24 @@ can be achieved with the following labels:
150150
You can propose contributions by sending pull requests through GitHub.
151151
Following these guidelines will help us to merge your pull requests smoothly:
152152

153-
1. If you're not sure your contribution would be accepted, and want to validate
153+
1. Eclipse OMR is an Eclipse Foundation project. All contributors must sign the
154+
[Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php) (or ECA)
155+
following the instructions on that page before a contribution is accepted.
156+
157+
See [Eclipse OMR Legal Considerations](#eclipse-omr-legal-considerations) for
158+
additional ECA considerations when creating project commits as well as copyright
159+
and license requirements for files.
160+
161+
2. If you're not sure your contribution would be accepted, and want to validate
154162
your approach or idea before writing code, feel free to open an issue. However,
155163
not every feature or fix needs an issue. If the problem and fix are cleanly
156164
connected, and you have the fix in hand, feel free to just submit a pull request.
157165

158-
2. Your pull request is an opportunity to explain both what changes you'd like
166+
3. Your pull request is an opportunity to explain both what changes you'd like
159167
pulled in, but also _why_ you'd like them added. Providing clarity on why
160168
you want changes makes it easier to accept, and provides valuable context to
161169
review.
162170

163-
3. Please read carefully and adhere to the legal considerations and
164-
copyright/license requirements outlined below.
165-
166171
4. Follow the coding style and format of the code you are modifying (see the
167172
[coding standards](doc/CodingStandard.md)). The code base is yet to be unified
168173
in style however, so if the file you are editing seems to have a diffferent
@@ -171,16 +176,17 @@ Following these guidelines will help us to merge your pull requests smoothly:
171176
5. Only use C++ language features supported by our compilers. A list of supported
172177
features can be found [here](doc/SupportedC++Features.md).
173178

174-
6. Follow the commit guidelines found below.
179+
6. Follow the [commit guidelines](#commit-guidelines) described below.
175180

176181
7. We encourage you to open a pull request early, and mark it as "Work In Progress"
177182
(prefix the PR title with WIP). This allows feedback to start early, and helps
178183
create a better end product. Committers will wait until after you've removed
179184
the WIP prefix to merge your changes.
180185

181186
8. If you are contributing a change to the compiler technology that involves modifications
182-
to the Testarossa IL (including, but not limited to, adding a new IL opcode, changing
183-
the properties of an opcode, or adding a new datatype) or, in the opinion of a committer,
187+
to the Testarossa intermediate language (IL) (including, but not limited to,
188+
adding a new IL opcode, changing the properties of an opcode, or adding a new datatype)
189+
or, in the opinion of a committer,
184190
a fundamental element of compiler infrastructure, a committer will request that this
185191
pull request be presented at an upcoming
186192
[OMR Compiler Architecture meeting](https://github.com/eclipse/omr/issues/2316)
@@ -331,26 +337,19 @@ If the hook declines your commit, the message will remain in
331337
Be sure to update your version of the script occasionally as it may evolve as
332338
our commit guidelines evolve.
333339

334-
## Legal considerations
335-
336-
Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
337-
338-
Your contribution cannot be accepted unless you have a signed [ECA - Eclipse Foundation Contributor Agreement](https://www.eclipse.org/legal/ECA.php) in place. If you have an active signed Eclipse CLA
339-
([the CLA was updated by the Eclipse Foundation to become the ECA in August 2016](https://mmilinkov.wordpress.com/2016/08/15/contributor-agreement-update/)),
340-
then that signed CLA is sufficient. You will have to sign the ECA once your CLA expires.
340+
## Eclipse OMR Legal Considerations
341341

342-
Here is the checklist for contributions to be _acceptable_:
342+
### Pull Requests
343343

344-
1. [Create an account at Eclipse](https://dev.eclipse.org/site_login/createaccount.php).
345-
2. Add your GitHub user name in your account settings.
346-
3. [Log into the project's portal](https://projects.eclipse.org/) and sign the ["Eclipse ECA"](https://projects.eclipse.org/user/sign/cla).
347-
4. Ensure that you author the commit using the _same_ email address as your Eclipse account.
348-
5. Include the appropriate copyright notice and license at the top of each file.
344+
When a pull request is created (or when new commits are pushed to an existing pull
345+
request), a webservice will automatically run that will verify that each commit
346+
author's email address matches an email address that signed the ECA.
347+
**This service is case-sensitive, so the case of the email addresses must match exactly.**
348+
The success or failure of this webservice will be reported in the GitHub pull request.
349+
Pull requests with a failing ECA check will not be merged.
349350

350-
Your signing of the ECA will be verified by a webservice called 'ip-validation'
351-
that checks the email address(es) that authored your commits has signed the
352-
ECA. **Note**: This service is case-sensitive, so ensure the email that signed
353-
the ECA and that authored your commits is the same, down to the case.
351+
Eclipse OMR pull requests do not need to be signed, but most contributors do so
352+
as a best practice.
354353

355354
### Copyright Notice and Licensing Requirements
356355

0 commit comments

Comments
 (0)