Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Oomph Contribution Guide
If you wish to contribute to Oomph, please obtain an Eclipse Gerrit account and provision your Oomph setup to use a Gerrit clone. Then you'll be able to commit your contribution to Gerrit for review. You'll also need an Eclipse account for bugzilla access and to post to the forums.
Here are some simple rules to follow for contributing to Oomph:
- All contributions should correspond to a bug report or feature request and each commit message should be prefixed using that bugzilla ID, i.e., [<bugzilla-id>].
- All code comments should be well-formed, grammatically-complete English sentences, e.g., they should start with an uppercase word and end with a period.
- All code should follow generally accepted Java naming conventions.
- All code should use the automatically enforced formatting rules so new projects are generally best created via the "Oomph->Copy Project" context menu action for an existing project.
Getting the source
To provision the same development environment that the Oomph developers use follow these simple steps:
- Download and start Oomph's Eclipse Installer.
- Drag this link and drop it on the installer's title area. Alternatively, copy the location of the previous link and apply it to the Eclipse Installer either via the menu in the upper right in simple mode or via the left-most toolbar button to the upper right in advanced mode.
- Review and/or edit the variable values that the installer presents.
- Click the Next/Finish buttons until the installation starts.
Contributing via Gerrit
Please refer to Gerrit.
Building
cd org.eclipse.oomph mvn -e clean verify -DskipTests=true
Where to find build artifacts
E.g. Linux 64 bit installer build is located under: org.eclipse.oomph/products/org.eclipse.oomph.setup.installer.product/target/products/org.eclipse.oomph.setup.installer.product/linux/gtk/x86_64
The update site for the installer is located under: org.eclipse.oomph/products/org.eclipse.oomph.setup.installer.product/target/repository
The update site for the oompf plugins is located under: org.eclipse.oomph/sites/org.eclipse.oomph.site/target/repository