How to Contribute to the BIRT Project

Interested in joining the BIRT project as a contributor? Maybe you found a bug and made a patch to the source code to address this, or perhaps you would like to make significant contribution in a specific area.

You can submit patches and minor enhancements via Bugzilla (see below). If you contribute a number of quality patches to the BIRT project, an existing project Committer may suggest you become a Committer yourself -- this would allow you to contribute directly to the source code for the project. In this case, the process outlined in the BIRT Project Charter would be followed to elect you to Committer status.

For more significant contributions to an existing area of the project, the BIRT Project Management Committee (PMC) has outlined a process that provides for review of the proposed contribution, as well as working towards becoming a Committer for that contribution. This is also described below.

In either case, the Eclipse Foundation needs to ensure that all committers to the code and/or the website and/or the bug system understand their role in safeguarding the intellectual property of Eclipse. The Foundation also needs to ensure that we have accurate records of the people who are acting as change agents on the projects. To understand this better, you should review the Eclipse New Committer guidelines.

Process for Patch and Minor Enhancement Contributions

For patches to specific bugs, you should make sure that there is a Bugzilla entry to track the item (with clear steps to reproduce the problem in the case of a bug) and then attach your code changes to the same Bugzilla entry with any explanation required in order to apply your changes to the source code. One of the existing project Committers will then review this and contact you as needed.

For enhancements, we also request that you provide:

  • A good example that illustrates the new feature in action. This will help us and the community understand how to use the new feature.
  • Documentation on the feature. This should describe the purpose of the feature, any public APIs in detail, any User Interface options and so on. This will provide a basis for the final documentation that gets incorporated into the project.

Process for Significant Contributions

The BIRT PMC has outlined the process under which a new contributor would get started with a significant contribution in an existing area of the project. Note that if the proposed contribution is for a new sub-project with BIRT, then the process is different and is described in the Proposal Phase of the Eclipse Development Process. This process is intended to work in tandem with, and does not replace, the Eclipse Foundation New Committer guidelines.
  1. New contributor develops a proposal a submits this to the BIRT PMC
  2. The PMC and existing BIRT contributors review the proposal
  3. New contributor provides some level of commitment to the PMC and state how many committers they ultimately see being involved.
  4. Assuming these initial steps are successful, the PMC gives initial provisional approval for the new contribution.
  5. The proposal is posted on the BIRT Wiki pages for community review, and a Bugzilla entry is created to track comments and feedback.
  6. New contributor develops a high level project plan for review
  7. In parallel and as a good faith offer, we grant the new contributor a temporary "observer" status on the BIRT PMC (assuming it makes sense for them to ultimately be part of the PMC).
  8. In parallel, and in the spirit of meritocracy that is a key element of the Eclipse Community, the new contributor makes initial contributions by fixing BIRT bugs in Bugzilla and attaching the patches to the bugzilla entries (since they will not have committer status). These will then be reviewed by a BIRT Committer and, if acceptable, checked into the code base. This allows the new contributor to gain familiarity with the code base and work towards becoming part of the BIRT community.
  9. Assuming bug fixing goes well, an existing Committer will nominate at least one individual from the new contributor to be a committer on the BIRT project after 10+ fixes have been submitted. Additional committers could be nominated once the project is underway.
  10. If the individual is accepted and they are not already an Eclipse Committer, the individual must complete the appropriate Eclipse process for New Committers.
  11. Once the new contributor attains Committer status, they contribute the new code (which they will hopefully have been developing in parallel according to their high level project plan).
  12. Once the new controibutor(s) are active on the project, the PMC would nominate and vote on the "Observer" becoming a full member of the PMC.