Jump to: navigation, search

Difference between revisions of "Platform UI/How to Contribute"

(Coding Conventions)
(3 intermediate revisions by 2 users not shown)
Line 35: Line 35:
 
Our current branches:
 
Our current branches:
  
* master - development towards Kepler/4.3
+
* master - development towards Luna/4.4
 +
* R4_3_maintenance - fixes for 4.3.x/Kepler service releases
 
* R4_2_maintenance - fixes for 4.2.x/Juno service releases
 
* R4_2_maintenance - fixes for 4.2.x/Juno service releases
 
* R3_8_maintenance - fixes for 3.8.x/Juno service releases
 
* R3_8_maintenance - fixes for 3.8.x/Juno service releases
Line 49: Line 50:
 
  ssh://<userid>@git.eclipse.org:29418/platform/eclipse.platform.ua
 
  ssh://<userid>@git.eclipse.org:29418/platform/eclipse.platform.ua
  
=== Creating a patch ===
+
=== Creating a Gerrit review or a patch ===
  
 
Once a Gerrit change set is created, the change set should be posted on the bugzilla it came from so it can be reviewed.
 
Once a Gerrit change set is created, the change set should be posted on the bugzilla it came from so it can be reviewed.
  
The preferred method of contributions is now [[Gerrit]] but we can accept patches on [https://bugs.eclipse.org/bugs bugzilla] or from public git repos as well.  Please see [[Platform-releng/Git Workflows#Create a patch]] for more information on the Eclipse Foundation IP process as it relates to both bugzilla and git repos.
+
The preferred method of contributions is now [[Gerrit]]. See [http://www.vogella.com/articles/Gerrit/article.html#eclipsegerritcontribution Contributing to Eclipse via Gerrit] for a detailed description.
 +
 
 +
While Gerrit is the preferred way of contributing to the Eclipse platform project, we also accept patches on [https://bugs.eclipse.org/bugs bugzilla] or from public git repos as well.  Please see [[Platform-releng/Git Workflows#Create a patch]] for more information on the Eclipse Foundation IP process as it relates to both bugzilla and git repos.
  
 
=== Unit Testing===
 
=== Unit Testing===
Line 73: Line 76:
 
* 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
 
* 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
 
* 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 and select "Remove trailing whitespace"
+
* 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ères to understand what it means to maintain an API.
 
* 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ères to understand what it means to maintain an API.
 
* Use the following format for your commit message:
 
* Use the following format for your commit message:
  
: Bug XXXX - bug title<br />
+
Bug XXXX - bug title<br />
: <space><br />
+
<space><br />
: Short description of what the fix contains, or the direction of the fix<br />
+
Short description of what the fix contains, or the direction of the fix<br />
: <space><br />
+
<space><br />
: Signed-off-by: email-with-CLA
+
Signed-off-by: email-with-CLA
  
 
=== Before You Check In ===
 
=== Before You Check In ===

Revision as of 01:56, 28 November 2013

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.

Bugs

If you find a bug, log it. See the FAQ entry "How to Report a Bug", and a description of how a 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.

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 has switched to git as its SCM. For the old CVS instructions, check out Platform UI/How to Contribute/CVS.

Getting the code into your workspace

See Platform-releng/Git_Workflows#Gerrit_workflow_for_a_committer. 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://<userid>@git.eclipse.org/r/platform/eclipse.platform.ui
ssh://<userid>@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://<userid>@git.eclipse.org/r/platform/eclipse.platform.runtime
ssh://<userid>@git.eclipse.org:29418/platform/eclipse.platform.runtime


Use git or EGit to clone this repo. See the instructions on setting up your repo for Gerrit for both EGit and/or the command line Gerrit#Doing Code Reviews with Gerrit.

If using EGit, see Platform-releng/Git Workflows#Clone a repo on suggestions on how to clone a repo and set up a branch.

Our current branches:

  • master - development towards Luna/4.4
  • R4_3_maintenance - fixes for 4.3.x/Kepler service releases
  • R4_2_maintenance - fixes for 4.2.x/Juno service releases
  • R3_8_maintenance - fixes for 3.8.x/Juno service releases

For more information on our development, see Platform UI/Git#Development in Juno

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

And we support User Assistance (Help) contributions at:

git://git.eclipse.org/gitroot/platform/eclipse.platform.ua.git
https://<userid>@git.eclipse.org/r/platform/eclipse.platform.ua
ssh://<userid>@git.eclipse.org:29418/platform/eclipse.platform.ua

Creating a Gerrit review or a patch

Once a Gerrit change set is created, the change set should be posted on the bugzilla it came from so it can be reviewed.

The preferred method of contributions is now Gerrit. See Contributing to Eclipse via Gerrit for a detailed description.

While Gerrit is the preferred way of contributing to the Eclipse platform project, we also accept patches on bugzilla or from public git repos as well. Please see Platform-releng/Git Workflows#Create a patch for more information on the Eclipse Foundation IP process as it relates to both bugzilla and git repos.

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 Standards, Conventions and Guidelines.
  • Every file must contain a copyright header, as described in Standards, 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.
  • UI will need you to use project-specific settings for compiler warnings/errors, code formatting etc. that are copied from the other UI plug-ins' settings.
  • Use "organize imports" (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 Evolving Java-based APIs by Jim des Rivières to understand what it means to maintain an API.
  • Use the following format for your commit message:

Bug XXXX - bug title
<space>
Short description of what the fix contains, or the direction of the fix
<space>
Signed-off-by: email-with-CLA

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: "Fixed bug xxx: <title of bug>". The "bug xxxx" 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 clown nose if it was really bad). If you do one thing it should be to sign up for the 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

We try to be prompt and responsive on the forum (newsgroup) but there's always room for improvement. If you know the answer to a query feel free to respond.

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 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.

Meetings

The team has bi-weekly phone calls for development discussions and planning. Anyone is welcome to join in. For call in details and minutes see E4/Meeting_Minutes.