Jump to: navigation, search

ECF/Contributions

< ECF

Hi,

Welcome to ECF, the Eclipse Communication Framework project. We love new contributions. We provide the OSGi community with a rich set of communication utilities. We specialize in remoting OSGi services through various protocols.

Thank you for considering your contribution.

Contact

Setup Your IDE

Follow this link to setup your IDE

Patches

We use Gerrit to accept all your patches.

Patches with a signed CLA

To provide patches to ECF, create an Eclipse account, get your Gerrit password and push your changes to the Gerrit git repo.

Please always use a valid bugnumber and use the following commit message:

Bug bugnumber  bug description 
<empty line>
Good description of the changes you made.

Change-Id: I0000000000000000000000000000000000000000
Signed-off-by: Your Name <your.name@yourdomain.ext>

To update an Existing commit, use the change Id that Gerrit has created for your original commit:

Bug bugnumber  bug description 
<empty line>
Good description of the changes you made.

Change-Id: I2ea25ad5deda4bc18a43894e2107196d2562869e
Signed-off-by: Your Name <your.name@yourdomain.ext>

Patches without a signed CLA

We are not allowed to accept patches, in any form, without a signed CLA.

New Contributions

Before you decide to contribute your code to Eclipse, keep in mind that your code must follow the EPL, Eclipse's Public License. This means that committers and contributors need to follow some rules.

A good overview of what this entails and how this affects you can be read here.

Introduce Yourself and your Contribution

If we don't know you, please take the time to introduce yourself to the ECF mailing list. Be elaborate. Things that you talk about could be your contributions, the bugs that you have filed, the patches that you committed, your experience in communications development, etcetera. We need to know who you are because we will have to work together. Don't be shy :)

You can subscribe to the mailing list by writing a mail to the mailing list administrator. How this is done is all explained on this page. Tell us what your plans are and what your code does. Then wait for the discussion. If nothing happens immediately: be patient and persistent. We love new contributions.

Code Quality and Citizenship

Once part of the ECF project, your code is visible to thousands of developers. Make sure that you provide quality code. Also make sure that your code is stable even if your API is not. The work that you provide represents the complete ECF community. Ask on the list if you are not sure.

Once you are in the project, take care of your bug reports and make sure that they are followed up. We require that you do not only take care of your own code but also look after the greater ECF together with the other committers.

File a bug to request your contribution

You will be instructed the project lead to file a bug against ECF core in bugzilla. Before you can do that, you need to get an Eclipse account.

Once the account has been created and the CLA is signed, you need to file a bug against ECF Core.

You need to include the source code and additional resources like images and stuff like that (one or more plug-in projects) as an attachment. Only the code that you or your employer owns and have the copyright of. Each source member needs to have the standard EPL header like you see in every Eclipse source. Do not include any third party code. Do not include any zip files in the projects. Just your sources and other resources. You can include some additional information like links to the working product or links to screenshots.

Ready? File a bug against ECF/Core.

Provide Legal Information

If your code is to be distributed from Eclipse, we need to you comply to some legal rules. One of the rules is the inclusion of copyright notices in source code and legal documents in features and plug-ins.

Information about this is described in A Guide to the Legal Documentation for Eclipse-Based Content which is linked from here.

We will assess your contribution

We will take a look at your code to assess the quality. If we have problems with it we will let you know on the bug. We will also do a preliminary check on any IP (Intelectual Property) issues. After this is done, the project lead will file a new bug in a separate Bugzilla system known as IPZilla. This bug is called a CQ (Contribution Questionnaire).

Here an automatic scanning of the source will take place. It will be examined on foul words, religious statements, terrorist information and all that. You will also need to declare that you have the rights to the code.

One of the Eclipse PMC members will do some magic and authorize the CQ. After this has been done, we have to wait on the Eclipse legal team to do a triage on the code and give their final OK.

Committer vote

The Eclipse committer vote is normally based on meritocracy. This means that you are invited by the community to participate based on what you have done. In case of a new code contribution, the ECF project lead may deviate from this rule but proposing you as committer as soon as the code is accepted by Eclipse legal.

The voting process is a formality but you cannot have any votes against you (-1). Once you are voted in (three or more +1), you will be provided with an Eclipse committer ID by the Eclipse Webmasters.

Checkin your code

With your committer account you can check-in your code into git. If you are not a committer yet, this will be done for you by one of the current committers. You will need the ssh link as provided on this page. Once your code is checked in, we have to add your widget to the build. If you are comfortable with it and able to do it (committer status), see the releng section of the repository for information and add your component, otherwise drop a line on the list and we are happy to help you with it.


Add Documentation to the Wiki

Your code needs to be documented on the ECf wiki.

Watch ecf-inbox

It is required that all committers watch this email address in bugzilla to stay up to date with what is going on in our community. Please login to bugzilla and then change your users-watching settings here:

https://bugs.eclipse.org/bugs/userprefs.cgi?tab=email

Become a committer

If you do not provide a new provider or other large chunks of new code but still want to become an ECF committer then the following applies:

Based on your role in the Eclipse community you can become a full committer in the ECF project. For this you have to show commitment to the project by maintaining your code and play an active role in the ECF community as a whole. Once this is established, you are invited by one of current committers of the project to become a committer. If you feel that you are ready for full committer status but you are not yet invited, you can solicit for the position yourself either through the list or by personal mail to the project lead.

The voting process is a formality but you cannot have any votes against you (-1). Once you are voted in (three or more +1), you will be provided with an Eclipse committer ID by the Eclipse Webmasters.