Skip to main content
Jump to: navigation, search

Developer Team Page

Revision as of 13:01, 10 June 2008 by (Talk | contribs) (Developing)


Higgins logo 76Wx100H.jpg

This page is information for active committers and contributors.

Meetings and Events




Version Numbering

There are four levels of granularity in the Higgins project:

SVN Projects
are named major.minor.service.qualifier as described in the "plugins" section here: Version Numbering. [For java projects every project is indeed a plugin. But for non-java projects a project might be a C++ lib, etc.] For projects (plugins) we are following the rules in Version Numbering.
We only have one feature and we DO follow the rules in Version Numbering.
in Higgins are sets of related projects. But they are just organizing concepts and not digital artifacts. We have not found a need to have version numbers for components. So there is no problem here.
in Higgins are complete working apps or web services. There is no equivalent concept in Version Numbering. We do not use version numbers at the solution level.
is the name for the entire project. This is roughly equivalent to numbering of the entire Eclipse IDE (e.g. Eclipse 3.1 or 3.2).
  • The first bugfix release after 1.0.0 will be 1.0.1 (see Beyond Higgins 1.0)
  • The first milestone (stable build) after 1.0.0 will be 1.1M1 (see Beyond Higgins 1.0)
  • We expect to have Higgins 1.1 stable builds approx every 6 weeks or so.


The list of all kinds of things that we might like to do someday is here:


Higgins Bug-Fix Release Criteria

Higgins patch releases (e.g. 1.0.X number scheme) would include exclusively bug fixes (e.g. no new features/enhancements) for the following type of bug severity:

  1. Bugs in any of the Higgins platform components that cause a crash of the overall Higgins system or Higgins based application.
  2. Bugs that cause a loss of any persistent data.
  3. Bugs that cause a severe security breach where sensitive end user data can be exposed to the outside world or accessed by unauthorized users.
  4. Bugs that cause a "major" feature to not function and there is no workaround available to accomplish the same task.
  5. Bugs that cause a "major" business impact such as loss of revenue or customers.

For all other bugs fixes of lesser severity than those described above, they will be included as part of major or minor (point) Higgins releases and not necessarily included as part of a special bug fix release. By way of example, the bug fixes included in the major or minor (point) releases would include such items as:

  • bugs that cause an aspect of a feature to not work properly.
  • bugs are that are cosmetic in nature, misspellings in dialogs, annoying to users, etc.

The following are the process guidelines Higgins team members should follow to support bug-fix releases:

  1. Ensure that a bugzilla ticket has been created for the issue outline the details of the bug in the ticket.
  2. Review the nature of their bug against the above outlined criteria
  3. If you feel the bug matches the criteria to be included in a future bug-fix release, send an email to Higgins-Dev and address request to Brian Walker to include this in an upcoming bug-fix release. Please note in the email whether the bug has been fixed already, or requires the component owner to work on creating the fix.
  4. If you have already made the code fix and you are not the component owner, all you need to do is submit the code fix to the appropriate component owner and request they commit the code fix.
  5. Most Important - when the code fix is committed, please make sure that the code is committed to the head branch, as well as the B-1-0-0 code branch as well. The patch release will be completed off the B-1-0-0 code branch.


Component Owners MUST:

  1. Create rows (and sometimes entire tables) for each project on the Components page.
  2. Manually create (and constantly update) the "dep" wiki page in the "Dependencies" column (entitled "Dep.") for each project/row on the Components page.
  3. Edit the autobuild scripts to include java components in the nightly build
  4. Create a "row" wiki page for each row using the Component Description Template
  5. Make sure that automated build scripts are using the latest build.xml
  6. Make sure that all 3rd party dependent jars are read from the dependencies.redistributable project. For projects that autobuild this can be verified by checking that the auto-generated "Third Party Dependencies" section of the "dependencies" page linked from a build page (see the "downloads" column on the Components page.

Solution Owners MUST:

  1. Add a link to the solution here Solutions
  2. Create the solution page using Solution Description Template

Anyone editing the wiki MUST:

  1. Put the string {{#eclipseproject:technology.higgins}} at the top of all pages. [This adds the correct Higgins left-hand navigation links to the page]
  2. Put the mouse on new pages by inserting the string [[Image:Higgins_logo_76Wx100H.jpg|right]] at the top of the page.
  3. Only version wiki pages if it is needed. If the same wiki page applies to Higgins 1.0 and any other release, there is no need to have more than one copy of the page. And the page doesn't need to have a "Version" section.
  4. If you need to version a page that hasn't been versioned before:
    1. Create two new pages that are copies of the original page. One copy will describe the released version and the other will describe the version that's under development.
    2. Add a version section at the top of each of the new pages as shown in the examples above.
    3. After you have created these new pages, change the original unversioned page such that it contains nothing but a #REDIRECT [[<page name>]] (where <page name> is the name of the page that describes the released version of Higgins.
  5. Categorize the page by including the category at the bottom of the page. See [1] for a list of all Higgins Categories. For example insert [[Category:Higgins]] for general Higgins info. (Yes, the categories could use some maintenance.). Or insert [[Category:Higgins Data Model]]

Technical References


  • All Java code MUST be developed using Eclipse 3.3
  • Higgins Conventions for file headers, copyrights
  • Project Structure and Naming
  • Eclipse policy on Project Dependencies
  • All Java code must build using JRE 1.4 (and must support both Sun and IBM JREs)
  • Special plugin we use: Higgins2Ant -- new page, needs work
  • All components and solutions must support internationalization. The goal is to have Higgins code internationalized, such that other users could localize the code to their native deployment requirements. Some specific elements of this would include:
    • Static strings must be stored in external resource bundles that can be called at runtime. These resource bundles can then be the focal point for localization.
    • We can leverage the Babel project/tool in Eclipse found here. This tool can be used to help in doing translations.
    • There are also some Eclipse plug-in internationalization 'how to' instructions for development and testing located here.



Misc Tools


Contributions by team members

Eclipse Foundation-related Info

Eclipse Committers



Clarification of IP processes for use of third party libraries

  • Any time anyone working on the Higgins project wants to introduce a project dependency, it needs to be brought forward to the Higgins project.
  • If the decision is made to introduce the dependency and the dependency involves software that is not licensed under the EPL, then a formal IP process needs to be gone though to approve the software binaries for inclusion in the project cvs. Note that this process must be followed even if the software is a common java library used by other Eclipse processes. (If the software has been used by another Eclipse project, the process is much faster.) Eclipse has a system IPzilla for managing this process. If you are anticipating a dependency, you need to bring it forward as soon as possible to allow time for the IP due diligence process to take place. See more about IPzilla below.
  • Libraries licensed with EPL are the easiest to get permission to use, followed by Apache 2.0. GPL and LGPL licences are not compatible with EPL.


  • Orbit is designed to be a repository for third party libraries that are approved for use in Eclipse projects. If the incoming libraries are not already bundles then Orbit committers will work to create a bundle that is suitable for use in Eclipse projects. See for a list or Orbit managed libraries. Orbit managed libaries are the easiest of third party libraries to add to an Eclipse project. Even if a library is listed under Orbit, you still need to go through the IPzilla process before putting it into the Higgins CVS.


Back to the top