- 1 New Contributions
- 1.1 Introduce Yourself and your Widget
- 1.2 Inclusion of your Widgets in an Existing Nebula Project (Inclusion)
- 1.3 Code Quality and Citizenship
- 1.4 File a bug to request your contribution
- 1.5 Provide Legal Information
- 1.6 We will assess your contribution
- 1.7 Become a committer
- 1.8 Create a Contribution to the Example View
- 1.9 Organize your Code
- 1.10 Checkin your code
- 1.11 Provide Build information
- 1.12 Add Component to the Website
- 1.13 Add Documentation to the Wiki
Hi, welcome to the Eclipse Nebula project. We love new contributions. We aim to provide the Eclipse community with a rich set of rich UI compoments. So thank you for considering your contribution.
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 Widget
If we don't know you, please take the time to introduce yourself to the Nebula mailing list. Be elaborate. Tell about your contributions, the bugs that you have filed, the patches that you committed. We need to know that you are a good Eclipse Citizen (Although this is not really necessary if you have a killer UI component to contribute ;).
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 UI component does. Then wait for the discussion. If nothing happens immediately: be patient and persistent. We love new contributions.
Inclusion of your Widgets in an Existing Nebula Project (Inclusion)
If you want to include your widget(s) into one of the existing Nebula projects then the following procedure starts:
- Your widget(s) will be voted in.
- You will be voted in.
The Nebula project lead will start a vote for the new contribution. This is an internal procedure for the Nebula project. The vote period is one week. For the vote to pass, we require three (3) +1's and no (0) -1's.
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 widget contribution, the Nebula project lead deviates from this rule but proposing you as committer as soon as the code is accepted by Eclipse legal.
The rationale for this process is based on the fact that there is no common code base in Nebula. All widgets are self sustained and isolated pieces of code, mostly maintained by their original contributor.
In case of Inclusion, only one committer is voted in. If your team consists of more then one committer then the other committers can earn their way in by providing contributions and showing their support to the Nebula project.
Code Quality and Citizenship
Once part of the Nebula project, your code is visible to thousands of developers. Make sure that you provide quality code. Also make sure that your widget is stable even if your API is not. The work that you provide represents the complete Nebula community. Ask on the list if you are not sure. Take a look at the widget author tips. The user interface is a very important part of any application.
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 component but also look after the greater Nebula together with the other active committers.
File a bug to request your contribution
You will be instructed by one of the project leads to file a bug against Nebula core in bugzilla. Before you can do that, you need to get an Eclipse account. This can be done on the Bugzilla landing page. Once the account has been created you need to file a bug against Nebula Core.
Here are some example bugs of previous contributions:
You need to include the source code and additional resources like images and stuff like that (one or more plug-in projects) as an attachement. Only the code that you own and have the copyright. 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 somoe additional information like links to the working product or links to screenshots.
In addition, You need to declare that:
- I authored 100% of the content
- I have the right to contribute the content to Eclipse
- I contribute the content under the EPL
Once you are ready, file the bug against Nebula/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, one of the project leads 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, terroristic 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.
Become a committer
Based on your role in the Eclipse community you can become a full committer in the Nebula project. For this you have to show commitment to the project by maintaining your code and play an active role in the Nebula community as a whole. Once this is established, you are invited by one of current committers of the Nebula 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.
Create a Contribution to the Example View
Nebula contains an overall Example View that provides an extension point. With this extension point you can contribute a Tab to the view that shows all the details of your widget.
All Nebula Widgets are required to contribute to this extension point in a separate bundle.
Organize your Code
You will get your own personal slot in the Nebula git repository.your component will be included into this folder. A GitHub mirror exists, but it cannot be used for pushing. It is also possible to become a sub project of the greater Nebula. You will then operate semi-independent from Nebula and take care of your own builds and repository.
If you are not your own sub project then you will first start in the Nebula incubation area. You will need to provide several components to become part of the Nebula code.
Lets take a look at the structure of the Oscilloscope widget.
- This is the main code of this widget. It is included in one project but your UI component can span more than one project. Please follow the namespace and discuss on the mailing list what the best name of the component can be.
- This is the contribution to the Example view. Every component is required to contribute to the example view. Here you can showcase your widget. Make it as fancy as possible.
- The feature project that will contain only your UI component. Please take a look at the contents of other features for inspiration. Make sure to provide the correct naming and descriptions in the feature and follow the same pattern as the other features.
- This contains the snippets for your code. Snippets contain short code examples on how to use your widget. This is mandatory. See other snippet projects for some inspiration.
- This contains the unit tests for your component. Obviously this is also mandatory. Please provide a code coverage of at least 80%.
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.
Provide Build information
Build and CI overview
We use tycho to build the Nebula after every commit. Please take a look at the pom.xml files in the other widgets and apply a copy and paste to your projects. Once you think your product is ready for the main stage, give the list a signal. We will then include your widget in the incubation build. It needs to stay there until it is API stable. If you break the build you break everything. So be careful with what you commit, take a keen eye on the build and fix any build errors as soon as possible.
Here are the links to our current build jobs:
Once you are a committer you have access to the build configuration.
Add your component to the build
Add poms to your folders
You will need to add pom.xml in your plugins and features. The best way to achieve that is to copy pom.xml from existing widget (beware, features, tests and bundles have different poms!). For a component myComponent, all poms will look like this:
<?xml version="1.0" encoding="UTF-8"?> <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <modelVersion>4.0.0</modelVersion> <parent> <artifactId>nebula-parent</artifactId> <groupId>org.eclipse.nebula</groupId> <version>1.0.0-SNAPSHOT</version> <relativePath>../../../releng/org.eclipse.nebula.nebula-parent</relativePath> </parent> <groupId>org.eclipse.nebula</groupId> <artifactId>org.eclipse.nebula.widgets.myComponent.bundleName</artifactId> <version>0.1.0-SNAPSHOT</version> <packaging>One of (eclipse-test-plugin | eclipse-plugin | eclipse-feature)</packaging> </project>
The only things to change are artifactId which must be your bundle name as defined in MANIFEST.MF, and packaging (for .examples, use eclipse-plugin).
Contribute to aggregation features and update-sites
Nebula contains aggregation features aimed to ease consumption of Nebula widgets. For all the next step, use dedicated editors in Eclipse (to avoid making mistakes), and always keep .qualifier suffix for versions. Add (assuming your new contribution gets into incubation):
- your .example bundle to the releng/org.eclipse.nebula.incubation.examples.feature/feature.xml.
- your .feature feature to the included features of releng/org.eclipse.nebula.incubation.feature/feature.xml.
- your .feature feature to the releng/org.eclipse.nebula.updatesite.incubation/category.xml in category Nebula Individual Incubation Widgets
Contribute to master pom
Tell maven that you want your stuff to be built by adding to releng/org.eclipse.nebula.nebula-incubation/pom.xml
<modules>...</modules> the relative path to your artifacts
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.eclipse.nebula</groupId> <artifactId>nebula-incubation</artifactId> <version>1.0.0-SNAPSHOT</version> <packaging>pom</packaging> <name>Nebula incubation parent</name> <description>Parent pom for all incubation widgets in Nebula</description> <properties> <tycho-version>0.13.0</tycho-version> <mockito-version>1.8.4</mockito-version> <junit-version>4.8.1</junit-version> <signer-input-directory>/home/data/httpd/download-staging.priv/technology/nebula</signer-input-directory> <download-publish-path>/home/data/httpd/download.eclipse.org/technology/nebula/incubation/snapshot</download-publish-path> </properties> <parent> <groupId>org.eclipse.nebula</groupId> <version>1.0.0-SNAPSHOT</version> <artifactId>nebula-parent</artifactId> <relativePath>../org.eclipse.nebula.nebula-parent</relativePath> </parent> <modules> <!-- Dependencies --> <module>../org.eclipse.nebula.nebula-parent</module> <module>../../examples/org.eclipse.nebula.examples</module> <module>../../examples/org.eclipse.nebula.examples.feature</module> <module>../org.eclipse.nebula.examples.incubation.feature</module> <!-- blah-blah .... --> <!--myComponent --> <module>../../widgets/myComponent/org.eclipse.nebula.widgets.myComponent</module> <module>../../widgets/myComponent/org.eclipse.nebula.widgets.myComponent.example</module> <module>../../widgets/myComponent/org.eclipse.nebula.widgets.myComponent.snippets</module> <module>../../widgets/myComponent/org.eclipse.nebula.widgets.myComponent.tests</module> <module>../../widgets/myComponent/org.eclipse.nebula.widgets.myComponent.feature</module> <!-- blah-blah .... --> <!-- Dist --> <module>../org.eclipse.nebula.updatesite.incubation</module> <module>../org.eclipse.nebula.incubation.feature</module> </modules> </project>
Test it locally before committing
From releng/org.eclipse.nebula.nebula-incubation, run a mvn clean install. Sit down and enjoy. If it looks fine you can push.
Add Component to the Website
Once you are a committer, you are able to checkout the website. If you checkin, the new code is published within 5 minutes. How to check out the Nebula website and make changes is explained here. If you have questions please ask them on the list.
Add Documentation to the Wiki
Your component needs to be documented on the main Nebula wiki page.