Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Oomph Contribution Guide"
(Created page with "If you wish to contribute to Oomph, please obtain an [http://wiki.eclipse.org/Gerrit#User_Account Eclipse Gerrit account] and provision your Oomph setup to use a Gerrit clone....") |
(Added some info abouf building Oomph bits, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=511359) |
||
| Line 6: | Line 6: | ||
# All code should follow generally accepted [http://java.about.com/od/javasyntax/a/nameconventions.htm Java naming conventions]. | # All code should follow generally accepted [http://java.about.com/od/javasyntax/a/nameconventions.htm 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. | # 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 == | ||
| + | git clone https://git.eclipse.org/r/oomph/org.eclipse.oomph | ||
| + | |||
| + | == 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 | ||
Revision as of 09:13, 31 January 2017
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
git clone https://git.eclipse.org/r/oomph/org.eclipse.oomph
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