Gyrex/Contributor Guide/Committer Resources
This article lists useful tips and articles for developers interested in working with/at the Gyrex code base.
Obtaining Source Code
Our regular (primary) SCM is Git. A list of available Git repositories can be found at git.eclipse.org/c/gyrex/. Contributions are welcome via Gerrit.
There are several ways to obtain a copy of each repository:
From the command line
Git: git clone git://git.eclipse.org/gitroot/gyrex/gyrex-server or HTTP: git clone https://git.eclipse.org/r/gyrex/gyrex-server or SSH (authenticated): git clone ssh://<username>@git.eclipse.org:29418/gyrex/gyrex-server or HTTPS (authenticated): git clone https://<username>@git.eclipse.org/r/gyrex/gyrex-server
From an installed EGit plugin
First, verify that the default repository folder as set on the main Git preference page is to your liking.
- File > Import > Git > Projects from Git
- Enter URI:
- Import existing projects into the workspace from the newly created working directory
Fork via GitHub
The folks at GitHub kindly setup mirrors of Eclipse Git repos at github.com/eclipse/. You may fork any repository you want there.
To compile properly you will also need to setup your Target Platform.
The Gyrex web site is also maintained in Git. Contributions are welcome via Gerrit. The Eclipse Webmaster team maintains an infrastructures which publishes any commit automatically to all web servers.
Git: git clone git://git.eclipse.org/gitroot/www.eclipse.org/gyrex
We use Gerrit for reviewing and accepting patches. Please have a look at the Eclipse Gerrit Guide.
- Make small logical changes.
- Provide a meaningful commit message.
- Review and follow the Eclipse Due Diligence Process
Policies & Guidelines
The Eclipse Gyrex Project follows the Eclipse Project API guidelines. Please look at API Central and read the resources carefully. In case of any questions please don't hesitate to ask on firstname.lastname@example.org mailing list.
Ramp Down Plan
Typically the last week of a Milestone is for testing, and fixing only regressions and P1 or blocking defects. For milestones, the component lead (or delegate) is enough to review and approve a bug.
For any M6 build, we plan to be API complete, so there will not be any more breaking API changes or unsolicited API change requests accepted.
After RC1 is produced, the time for general functional improvements is long past. The following describes the types of bugs that would be appropriate:
- A regression
- A P1 or P2 bug, one that is blocking or critical, and some cases of major severities.
- Documentation and PII files are exceptions to the normal PMC required review, since there is little chance of that breaking anything, though it is still expected to be complete by M6, and remaining work to be only documentation fixes (that is, no refactoring of plugins, build changes, etc, without PMC review and approval).
- In addition to a bug meeting the above priority/severity conditions, there should be a simple, safe, well understood fix that is well isolated from effecting other components, that doesn't affect API or adopters, that has been well reviewed and well tested.
- As each Release Candidate passes, the criteria for weighing the benefit-to-risk ratio criteria gets higher and higher, and as such requires a larger number of project members to review.
- After RC1: Another committer from the project must review and vote + using Bugzilla (see below).
- After RC2: Another committer from the project and a project lead must review and vote +1 after reviewing the bug for appropriateness and risk.
Bugzilla Usage for RC Fixes
Committers can signify their approval for submitting fixes as required after RC1 by simply indicating +1 in a comment.
Bugzilla has a flag feature that is to be used for obtaining PMC approval. Enter the email address of the PMC member you are requesting approval from and submit. The PMC member is notified via email and will change the flag from '?' to '+' or '-' as appropriate.
Backporting fixes for service releases
- Bugfixes should be backported to the maintenance branch only if they match the criteria above.
- A review is required if bug fixes should be backported.
- A patch must be attached to every bug which is backported.
- If a bug has been backported for a service release, a tag of the form "srX_Y_Z" must be added to the status whiteboard field in bugzilla, where X_Y_Z is the service release number without dots (e.g. "sr0_10_1" for Gyrex 0.10.1).
- To request backporting for a service release, a tag of the form "srX_Y_Z?" can be used.