View source for Platform/How to Contribute

This page is a starting point for where to begin when wanting to contribute to the project.  The goal is to educate and to be as up front as possible with expectations so that the process can be as efficient as possible.
{{Platform UI}}
== Bugs==
If you find a bug, log it.  See the FAQ entry [[../FAQ#How_do_I_report_a_bug.3F|"How to Report a Bug"]], and a description of how a [http://borisoneclipse.blogspot.com/2005/10/great-bug-report.html great bug report] looks like.  If you find a bug that you think is a duplicate, is not a bug, etc. feel free to comment saying so.  

If wanting to track bug changes in Platform UI there are a few ways:
* Via email.  If you want to receive email when a bug is logged you can watch the '''Platform-UI-Inbox@eclipse.org''' user.  You will receive email anytime a new bug is logged to this user or an update is made while assigned to this user.  To set this up see Preferences -> Email Preferences -> User Watching.  This will email you for all incoming Platform UI bugs; to follow all changes for Platform UI and IDE for bugs that an individual has not yet taken, watch '''platform-ui-triaged@eclipse.org''' as well.
* Via Atom.  You can convert any query in bugzilla to a feed that will update when a matched bug changes.  To convert a search to a feed perform a search and select "Feed" at the bottom of the search results.

== Bug triage==

If you are interested to help with bug solving, the Eclipse platform project has a huge backlog of existing bug reports. It is often not possible for the committer to re-test all old bug reports. A contributor can re-test bug reports and report if they are already solved. If you want to help in this area, please send a message to the [https://dev.eclipse.org/mailman/listinfo/platform-ui-dev platform.ui mailing list]. We can nominate you to give you rights to close bugs via the process described [https://wiki.eclipse.org/Bug_Reporting_FAQ#Bug_Editing_and_Triage Platform Bug triage process]. 

== Setting up your SDK for code contributions ==

First you need to set up your environment. You need to:

# Get an Eclipse SDK
# Install the tools we use during development
# Get the code for Platform UI
# Use the correct target platform

Our currently active branches:

* master - development towards the next release
* R4_5_maintenance - fixes for 4.5.x/Mars service releases, no active development but sometimes we cherry pick patches from master to it

=== 1. Get an Eclipse SDK ===

To get the required updates from other subprojects it is recommended to use a recent I-Build for the Eclipse SDK for contributions. See from http://download.eclipse.org/eclipse/downloads/ for the latest download.

=== 2. Install the development tools ===

The Eclipse SDK development requires that certain plug-ins are installed in your IDE. The Eclipse platform team provides a file from which these plug-ins can be installed. Download the following file onto your computer: http://git.eclipse.org/c/platform/eclipse.platform.ui.git/plain/releng/org.eclipse.ui.releng/platformUiTools.p2f

You can install the plug-ins described by this file by using ''File>Import...>Install>Install Software Items from File''.  

In case you plan to work on Luna SR1, use the version from the R4_4_maintenance branch in Git.

==== 3. Get the code for Platform UI ====

* Use ''File>Import...>Team>Team Project Set'' to import the Platform UI projects into your workspace.  

==== 3.1 Use Gerrit for clone/push ====

Use http://git.eclipse.org/c/platform/eclipse.platform.ui.git/plain/releng/org.eclipse.ui.releng/platformUiProjectsGerrit.psf.

Gerrit allows both committers and contributors to clone and push to right projects. After project import open ''Git Repositories'' view, expand repositories, right click on the ''Remotes->origin'' node, select ''Gerrit Configuration'' and click ''Finish''. That's all, now you can commit and ''Team->Push to Upstream'' will push your commits directly to Eclipse Gerrit instance. First time push dialog will ask you for your Gerrit username and password, which you can see if you are logged into Gerrit under [https://git.eclipse.org/r/#/settings/http-password ''Settings->HTTP Password''].

==== 3.2 Use ssh for clone/push ====

Use http://git.eclipse.org/c/platform/eclipse.platform.ui.git/plain/releng/org.eclipse.ui.releng/platformUiProjects.psf.

Please note that the user id of your host will be used as gerrit user id to connect to eclipse servers. If they are not matching you have three solutions:
* Modify URL directly in the file to specify gerrit user id, ssh://gerritUserid@git... instead of ssh://git
* Modify the URL to point to the ''https'' version of the Gerrit repo location, https://gerritUserid@git...
* Modify URL directly in the file in order to point to http://git.eclipse.org/gitroot for anonymous access (you won't be able to push changes for review).

When using ssh, you also need to upload your ssh key if not already done. See [https://wiki.eclipse.org/Gerrit#Git_over_SSH Gerrit over SSH] for more information.  When using ''https'' with Gerrit, you'll need to set your https password in Gerrit.  See [https://wiki.eclipse.org/Gerrit#Git_over_HTTPS Gerrit over HTTPS].

When you are using ssh with a passphrase you probably get ''USERAUTH fail'' errors (possible import wizard bug). As workaround start cloning a repository listed in the team project set via the default EGit wizard over ssh. After you entered the passphrase you should see the available branches -- you can now abort the EGit wizard and retry importing the team project set as JGit should have been cached the ssh information.

=== 4. Tweaks for after your environment is set up ===

'''API Baseline Errors''':  For developing on the latest version, you can either unzip latest stable version of Eclipse and use that install as the API baseline or go to ''Preferences>Plug-in Development>API Baseline'' and set the missing API baseline to Ignore.  Committers and regular contributors '''must''' set their API baseline.

'''Build Path problems''': if you have build path problems for org.eclipse.core.expressions* you need to go to ''Preferences>Java>Installed JREs'' and add the missing JREs.  This usually involves getting an install for 1.4, 1.5, 1.6, and 1.7.

'''Running the tests''': you should be able to run a couple of pre-filled launch configs from ''Run>Run Configurations''.  '''on linux''': The launch configs often come with DISPLAY=:1.0.  You should either run a vnc server or remove that variable from the environment tab.  An example of a $HOME/.vnc/xstartup that works for the Platform UI tests is:

 #!/bin/sh
 
 # Uncomment the following two lines for normal desktop:
 # unset SESSION_MANAGER
 # exec /etc/X11/xinit/xinitrc
 
 [ -x /etc/vnc/xstartup ] && exec /etc/vnc/xstartup
 [ -r $HOME/.Xresources ] && xrdb $HOME/.Xresources
 xsetroot -solid grey
 #vncconfig -iconic &
 xterm -geometry 80x24+10+10 -sb -sl 5000 -ls -title "$VNCDESKTOP Desktop" &
 #gnome-session --sm-disable --failsafe --disable-sound &
 
 exec metacity --replace --sm-disable


'''Pushing a Gerrit commit''': Make sure you use the signed-of-by and change-id buttons before you create your commit.  If you haven't, just amend your commit and add them.  Then you can push a commit for review by switching to the Git Repositories view, right-clicking on the repo, and selecting '''Push to Gerrit...'''.  You want to enter the branch you are pushing to, for example '''refs/for/master'''.  That will create a Gerrit review, and the review URL will be in the dialog that contains the status.  The git command line equivalent would be:

 git push origin HEAD:refs/for/master

== Contributing Code==
Whether you're wanting to fix a typo in javadoc or to implement the next whiz bang feature for Platform UI you'll need to know a few things before you contribute code.

Platform UI is using Git as version control system.

=== More information about getting the code into your workspace ===

See [[Platform-releng/Git_Workflows#Gerrit_workflow_for_a_committer]] and  [[Gerrit#Doing Code Reviews with Gerrit]].  Even if you are a contributor, the workflows should give you an idea of how to get set up.


Our code is now contained in the git repo at
 git://git.eclipse.org/gitroot/platform/eclipse.platform.ui.git
 https://&lt;userid&gt;@git.eclipse.org/r/platform/eclipse.platform.ui
 ssh://&lt;userid&gt;@git.eclipse.org:29418/platform/eclipse.platform.ui

The Dependency Injection and runtime Eclipse Context code is in
 git://git.eclipse.org/gitroot/platform/eclipse.platform.runtime.git
 https://&lt;userid&gt;@git.eclipse.org/r/platform/eclipse.platform.runtime
 ssh://&lt;userid&gt;@git.eclipse.org:29418/platform/eclipse.platform.runtime



Note: we also maintain some E4-specific tools, hosted in the e4 incubator at (supports Gerrit):
 git://git.eclipse.org/gitroot/e4/org.eclipse.e4.tools.git
 https://&lt;userid&gt;@git.eclipse.org/r/e4/org.eclipse.e4.tools
 ssh://&lt;userid&gt;@git.eclipse.org:29418/e4/org.eclipse.e4.tools

And we support User Assistance (Help) contributions at:
 git://git.eclipse.org/gitroot/platform/eclipse.platform.ua.git
 https://&lt;userid&gt;@git.eclipse.org/r/platform/eclipse.platform.ua
 ssh://&lt;userid&gt;@git.eclipse.org:29418/platform/eclipse.platform.ua

=== Creating a Gerrit review or a patch ===

The preferred method of contributing bugfixes or new features is via the [[Gerrit]] review system. Once a Gerrit change set is created, the link to the Gerrit change should be posted on the Bugzilla. If you are using the [https://wiki.eclipse.org/Platform_UI/How_to_Contribute#Commit_Message_Conventions correct commit format], this is done automatically by the Eclipse infrastructure.

See [http://www.vogella.com/tutorials/EclipsePlatformDevelopment/article.html#eclipsecontribution_usersetup Contributing to Eclipse via Gerrit] for a detailed description.

It is totally fine to upload a partial fix so that people can give early feedback, please mark in case the review so, e.g., by using [WIP] in the commit message. WIP stands for Work in Progress.

=== Unit Testing===
Testing is imperative to the health of the project.  We have a significant amount of tests.  The quantity of tests will keep growing as more functionality is added to Platform UI.  If you are contributing a fix or writing an enhancement, it is a requirement that tests are written.  If you don't write them a committer will have to and that could slow down the contribution process.  

There are a couple of things that you should know about our testing process:
* The most tests are included in org.eclipse.ui.tests, but you will need the other test plug-ins as well to avoid missing dependencies.
* If looking for tests for a specific class look for a class named {THECLASS}Test.java (e.g. UpdateStrategy.java -> UpdateStrategyTest.java).
* To run tests, open the Run Configurations dialog (Ctrl+3, 'run...') and expand the "JUnit Plug-in Test" category to see the launch configurations we use to run the tests.
* If you create a new TestCase make sure to add it to the correct test suite. The test suite class can be found by looking at the launch configuration on the "Test" tab under "Test class". For example, the test suite for JFace is called org.eclipse.jface.tests.AllTests; the main UI test suite is org.eclipse.ui.tests.UiTestSuite.
* If you want to make a good impression, write tests.  This goes for any project, of course.

=== Coding Conventions ===
* Follow the Eclipse Platform's [[Development Conventions and Guidelines]].
* Every file must contain a copyright header, as described in [[Development Conventions and Guidelines]]. The copyright header goes before the package declaration, starting in the very first line. For new files, list "yourself and others" instead of "IBM and others" in the first line. For changed files, add a contribution comment in the copyright header with your name and affiliation, and a bug id. If the top "Copyright (c)" line does not contain the current year, update it by changing the second year to be the current year or by adding a comma and the current year after the initial year.
For instance:
{{codeblock|/*******************************************************************************
 * Copyright (c) 2008, 2014 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     John Doe <John.Doe@eclipse.org> - Bug 429728
 *******************************************************************************/}}
* UI will need you to use project-specific settings for compiler warnings/errors, code formatting, save actions etc. These settings are typically copied into new projects from an existing one.
* Avoid formatting the whole files - as this can generate pseudo-changes (white-space related) when committing changes to existing source files.
** The easiest way, for Java files, is to have "Format edited lines" activated in the Preferences -> Java -> Editor -> Save Actions (this ''should'' be already pre-configured in the project settings).
** One can also format just the needed block by selecting it and using "format" (Ctrl+Shift+F).
* Use &quot;organize imports&quot; (Ctrl-Shift-O) to clean up the imports (we do not use org.eclipse.* type notation).
* It is considered good practice to write code that does not have warnings. If possible, fix warnings existing whenever you see them.
* Non-externalized strings are considered errors, do not ship non-externalized strings or use the NON-NLS tag to indicate that you are not relevant for translation
* Use unix line delimiters (In Eclipse select Window-> Properties -> Workspace and set the file delimiter to Unix
* Avoid adding trailing whitespace. You can use the save actions in Eclipse to auto-remove them, via the Preferences -> Java -> Editor -> Save Actions. Activate them and as additional action select Configure and select "Remove trailing whitespace"
* Write/update Javadoc for all API you introduce/change. See [http://wiki.eclipse.org/index.php/Evolving_Java-based_APIs Evolving Java-based APIs] by Jim des Rivi&egrave;res to understand what it means to maintain an API.

=== Commit Message Conventions ===

* In general, each commit with functional code changes requires a bug entry, and a commit with trivial changes does not.
* A commit related to an existing bug report has to start with "Bug XXXXXX - " or "Bug XXXXXX: " or "Fixed bug XXXXXX: summary".
* Don't tie unrelated changes to a bug (number) just because you are working on that bug. Simply use e.g. "Fixed typo in XYZ" or "Removed trailing whitespace in XYZ". 
* Don't include such unrelated changes in the real fix/change.
* The change summary should be short, clear and concise description about the change.
* The body of the commit message should be more detailed explanatory text (if necessary), describing the change.
* Use the following format for your commit message. The Change-Id is only required if you use Gerrit.

{{codeblock|Bug XXXXXX - Functional change in service XYZ
 
 More detailed explanatory text (if necessary), describing the change, the direction of the fix etc.
 
 Change-Id: I0000000000000000000000000000000000000000
 Signed-off-by: Your Name <your.email@with-CLA.org>}}

=== Before You Check In ===

* Commit comments are required for all code commits, bugs should be logged to track work and the bug number and a description is then used in the commit comment to describe the change. For example when fixing a bug, use exactly: &quot;Fixed bug xxx: &lt;title of bug&gt;&quot;.  The &quot;bug xxxx&quot; part is really important as this is what is used to relate the bugs to the build submissions, so it must be formatted exactly that way (uppercase or lowercase bug should work).  
* Before committing changes, catch up to all changes made by others, and then run the tests.
* Don't commit your changes if this will cause compile errors for others.

=== The Build===
The Eclipse build is a bit of a mystery to newcomers.  But rest assured that if you break something everyone will know about it and we will laugh at you (not really but we might tease you, or send you a [http://dev.eclipse.org/mhonarc/lists/platform-releng-dev/msg09764.html clown nose] if it was really bad).  If you do one thing it should be to sign up for the [https://dev.eclipse.org/mailman/listinfo/platform-releng-dev platform-releng-dev mailing list].  You'll receive emails when builds complete and when build and test failures occur.  It's always good to pay extra special attention on the mornings after you make a commit or someone makes a commit on your behalf.  The normal reaction to "breaking the build" is to log a bug, notify the platform-releng-dev list about it so that others can gauge the quality of the build, and then fix the bug.

== Forum ==
The [http://www.eclipse.org/forums/?group=eclipse.platform Eclipse platform forum] (newsgroup) is used to ask and answer questions. If you know the answer to a query it would be great if you would respond to it. Also the [http://www.eclipse.org/forums/index.php/f/12/ Eclipse 4 forum] is meant for pure Eclipse 4 (non 3.x) related questions. 

== Wiki==
The wiki is open and can be edited by all. If you find a typo, a broken link, or anything that you view as a small issue feel free to fix it.  If wanting to contribute a significant amount of information or create a new article we request that you [[../FAQ#How_do_I_report_a_bug.3F|log a bug]] so that we're aware of what you're contributing.  This is so that we can ensure consistency structurally and in the message conveyed.

== IRC ==

Many Platform UI committers hang out on [[IRC]], on both #eclipse-dev and #eclipse-e4. Feel free to ask questions there, or join into development discussions.

[[Category:Platform UI]][[Category:How to Contribute]]

== Meetings ==

There are currently no calls scheduled. They can be arranged upon request.
For call in details and minutes see [[E4/Meeting_Minutes]].