Difference between revisions of "Virgo/Committers"

From Eclipsepedia

Jump to: navigation, search
m
(Handling Code Contributions)
Line 92: Line 92:
 
== Handling Code Contributions ==
 
== Handling Code Contributions ==
  
Committers are responsible for ensuring that Eclipse IP policy, summarised in the [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf legal poster], is adhered to. Patches must be attached to a bugzilla bug, the bug must have its iplog flag set to '+', and the contributor must confirm in the bug that: they wrote 100% of the code, they have the right to contribute the code to Eclipse, and new Java file headers contain the appropriate License header.
+
Committers are responsible for ensuring that Eclipse IP policy, summarised in the [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf legal poster], is adhered to.
 +
 
 +
Patches must be attached to a bugzilla bug, the bug must have its iplog flag set to '+', and the contributor must confirm in the bug that: they wrote 100% of the code, they have the right to contribute the code to Eclipse, and new Java file headers contain the appropriate License header.
 +
 
 +
If the contribution is provided in an external git repository, it is not necessary to attach a patch to the bug: details [http://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions here].
  
 
== Raising "works with" CQs  ==
 
== Raising "works with" CQs  ==

Revision as of 19:52, 25 March 2011


Contents

Committers Charter

Committers are responsible for:

  • Maintaining and enhancing the Virgo code base
  • Ensuring the Hudson CI jobs pass all tests (blue ball)
  • Responding to queries on virgo-dev
  • Handling contributions
  • Developing contributors into committers
  • Complying with Eclipse IP policy
  • Keeping an eye on the Virgo forum

Machine Setup

You need Sun JDK 6, Apache Ant 1.7.1 or later, and git. You'll probably want an IDE such as Eclipse.

At the time of writing, some ant targets occasionally fail because they cannot load classes from jsch-0.1.42.jar. A workaround on Mac OS X is to copy this JAR from virgo-build's /lib/ivy directory to /opt/local/share/java/apache-ant/lib.

On Mac OS X, increase the default number of concurrently open files by adding this to .profile:

       ulimit -n 10000

To run certain scripts (don't run them unless you know what you're doing—and why), you'll need ruby, gems, and the 'choice' gem. On Mac OS you can get these by installing the XCode tools (from the Mac OS X disk) and MacPorts, then issuing:

       sudo port -v install ruby
       sudo port -v install rb-rubygems 
       sudo gem install --remote choice

To run scripts such as Releaselor or Ripplor you'll need to:

  1. Generate SSH key by calling ssh-keygen without a passphrase
  2. Upload your public SSH key to build.eclipse.org
    • login with user virgoBuild
    • follow the steps described here
  3. Log in (adding the host key) at lease once to:
    • build.eclipse.org
    • download1.eclipse.org
  4. Add your private key to ANT_OPTS:
       -Dkey.file=$HOME/.ssh/id_dsa

If you have headless environment you may want to add to ANT_OPTS:

       -Djava.awt.headless=true

To enable Clover you will need to specify in ANT_OPTS the path to the licence:

       -Dclover.license.path=/opt/clover.license

Notes for Ubuntu 10.04

I have found that the sun-java6-jdk package is not installable directly from a fresh install of this level of Ubuntu (I'm running this in a virtual machine). (I set JAVA_HOME to be /usr/lib/jvm/java-6-sun which is a symbolic link, and this doesn't need updating after the install below.)

To get the jdk to be installed I issued the following commands (which you might find useful):

   sudo add-apt-repository "deb http://archive.canonical.com/ lucid partner"

(which made the package visible to the package-manager)

   sudo apt-get update

(to reset the package-manager indexes)

   sudo apt-get install --fix-missing sun-java6-jdk

The --fix-missing option is necessary since other packages are required.

Policies

In addition to detailed coding and testing policies describe later, there are some specific policies that committers need to be aware of.

Event Log Message Policy

Please avoid renumbering event log messages when possible. People sometimes write scripts that act on event log messages. Some of our tests may even be sensitive to the numbers. So renumbering an event log message can cause unnecessary disruption to our users and ourselves.

Coding

Virgo has a strong emphasis on maintainable, or "clean", code. If you need a really good introduction to coding, we recommend "Code Complete". If you are already a proficient programmer and want to write really clean code, read "Clean Code". If you are not an expert in writing Java, read "Effective Java".

Virgo code is thread safe unless specifically stated. Achieving thread safety in Java is not easy. We recommend "Java Concurrency in Practice" for a good grounding in Java concurrency.

Coding guidelines are here.

Testing

See Test.

Hudson CI

Committers should subscribe to virgo-build@eclipse.org so they are notified when builds fail, become unstable, become stable, etc.

Build breaks should be investigated as soon as they occur and should be fixed as soon as possible.

IP Due Diligence

Handling Code Contributions

Committers are responsible for ensuring that Eclipse IP policy, summarised in the legal poster, is adhered to.

Patches must be attached to a bugzilla bug, the bug must have its iplog flag set to '+', and the contributor must confirm in the bug that: they wrote 100% of the code, they have the right to contribute the code to Eclipse, and new Java file headers contain the appropriate License header.

If the contribution is provided in an external git repository, it is not necessary to attach a patch to the bug: details here.

Raising "works with" CQs

"works with" CQs are required for test dependencies which are not distributed with Virgo or checked in to Eclipse version control (git, svn, cvs).

The initial set of test dependencies was determined, for repositories which are built with ant, as follows:

1. In the build-xxx directory run ant report

2. Extract a raw list of the test dependency jars

find <report directory> -name "*-test.xml" -exec grep -E \/.+\.jar  {} \; >test-jars.txt

3. Edit test-jars.txt using an editor with a regular expression global change facility and do the following global changes.

3.1 Replace regex .+\/(.+)\.jar\"> with $1.jar.

3.2 Replace regex .+\/(.+)\.jar\"\/> with $1.jar.

3.3 Replace -sources with the empty string

4. Sort test-jars.txt and remove duplicate lines.

5. Look through test-jars.txt and raise "works with" for any JARs which don't have a Virgo CQ for the correct version. Also, raise corresponding Virgo bugzillas and set the iplog flag to enter the bugzillas in the automated IP log.

Development process advice

To enable distributed and cooperative development, some simple rules and processes need to be followed. These are all subject to change and are in the nature of advice rather than laws.

The advice is here.

Agile Project Management

The basic principle is that tasks which need to be worked on are placed in the backlog. For a particular sprint, some of the tasks in the backlog are moved to the sprint and completed. So no task appears in both the backlog and a sprint.

Import bugs from bugzilla into Acunote as follows:

  1. Export all the open bugs for Virgo (and Gemini Web if you like) to a CSV file using the CSV link on the bugzilla search results panel.
  2. Go to the "Imported from bugzilla" sprint (not really a sprint at all) and import the CSV using the Tools link followed by "Import tasks from Bugzilla" (not "Import tasks from CSV"). Make a note of the task numbers added.
  3. Go to the "Imported from bugzilla" sprint and copy the tasks added in the previous step to the backlog.
  4. It is helpful to categorise bugs and features using the "More Actions" pull down. We put the bugs at the top of the backlog so we don't lose track of them.

To work on a sprint:

  1. Add a sprint.
  2. Move tasks from the backlog into the new sprint to work on them. If you don't complete them, move them to a new sprint or move them back to the backlog.


Since we are trying to use Acunote to manage sprints in Southampton, Sofia, and potentially elsewhere, please ensure that bugzilla is kept up to date in case the Acunote data gets corrupted.

Note that we never remove tasks from the "Imported from bugzilla" so that subsequent imports do not accidentally re-create finished tasks. The maintainers of Acunote recommended this technique.