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 "Tycho/Contributor Guide"
(encourage people to talk to us before working on a patch; clarify that contribution questions are also needed for Gerrit; add ssh push URL of our repo; polished commit message section) |
(→Legal Paperwork) |
||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 9: | Line 9: | ||
The technical basics (how to get the sources, how to import and build, etc.) are described here: [[Developing Tycho]] . | The technical basics (how to get the sources, how to import and build, etc.) are described here: [[Developing Tycho]] . | ||
| − | + | Unless the patch is really trivial, make sure you include at least one test case that reproduces the bug or proves that the enhancement works. | |
| + | |||
| + | Note that if '''you don't provide any tests, we will not take the contribution'''. | ||
=== Writing Tests === | === Writing Tests === | ||
| Line 24: | Line 26: | ||
* Also in the first line, provide a clear and concise description of the change | * Also in the first line, provide a clear and concise description of the change | ||
* Add one blank line, followed by more details about the change. This could include a motivation for the change and/or reasons why things were done in the particular way they are done in the change. | * Add one blank line, followed by more details about the change. This could include a motivation for the change and/or reasons why things were done in the particular way they are done in the change. | ||
| + | * Add "Bug: <bug number>" in the footer. | ||
| + | * Add "Signed-off-by: <your_email_adress>" in the footer (see "Legal Paperwork" below). | ||
| + | |||
| + | See here for an [http://git.eclipse.org/c/tycho/org.eclipse.tycho.git/commit/?id=52ca41640484f108cae9fcaadb1c105e686dd985 example commit message] | ||
| − | |||
| − | |||
=== Commit Granularity === | === Commit Granularity === | ||
| Line 34: | Line 38: | ||
== Contributing the Patch == | == Contributing the Patch == | ||
| − | === | + | === Legal Paperwork === |
| − | + | Before your contribution can be accepted by the project, you need to create and | |
| + | [[Development Resources/Contributing via Git#Eclipse_Foundation_Contributor_License_Agreement | electronically sign the Eclipse Foundation Contributor License Agreement (CLA)]] and sign | ||
| + | off on the Eclipse Foundation Certificate of Origin. | ||
| − | + | Follow the instructions on [[Development_Resources/Handling Git Contributions]] | |
| − | + | ||
| − | + | ||
| − | + | In general, also see [[Development Resources#Users: Contributing To A Project]]. | |
| − | + | === Pushing to Gerrit === | |
| − | + | The [https://git.eclipse.org/r/#/q/project:tycho/org.eclipse.tycho+status:open,n,z Eclipse Gerrit] is the preferred way to propose patches to Tycho. Everyone with an Eclipse Bugzilla login can propose patches. | |
| − | + | In order to propose a change to Tycho | |
| + | * Configure the repository URL <tt>https:</tt><tt>//git.eclipse.org/r/tycho/org.eclipse.tycho</tt> for the remote "origin" | ||
| + | * Know your [https://git.eclipse.org/r/#/settings/http-password Gerrit HTTPS user name and password] | ||
| + | * Push to the special code review branch "refs/for/master", e.g. with <tt>git push origin HEAD:refs/for/master</tt> | ||
| − | + | For more information on the Eclipse Gerrit instance (e.g. how to push via SSH), see here: [[Gerrit]]. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | Note that prototypes and other incomplete work should be clearly marked as such e.g. by adding "POC" or "WIP" in the commit message, by commenting in Gerrit, or by pushing to the refs/for/master/POC topic branch. This avoids that committers spend time on reviewing incomplete changes. | |
| − | + | ||
| − | + | ||
[[Category:Tycho|Contributor Guide]] | [[Category:Tycho|Contributor Guide]] | ||
| + | [[Category:How to Contribute]] | ||
Revision as of 08:42, 17 September 2014
Contents
Starting a Contribution
Before starting to develop an enhancement or fix for Tycho, it is important that you get in touch with the project. We track ideas for enhancements and bug reports in the Eclipse Bugzilla, so this is a good place to present your ideas for a patch and to make sure it's going in the right direction.
If you want to do an enhancement but don't know where to start, you can also just ask on tycho-dev@eclipse.org.
Developing Patches for Tycho
The technical basics (how to get the sources, how to import and build, etc.) are described here: Developing Tycho .
Unless the patch is really trivial, make sure you include at least one test case that reproduces the bug or proves that the enhancement works.
Note that if you don't provide any tests, we will not take the contribution.
Writing Tests
Tycho has two types of tests: unit tests (locally in each module) and a global integration test suite in module tycho-its.
Unit tests are preferred if possible because they are in general much faster and better targeted at the functionality under test. Integration tests generally invoke a forked maven build on a sample project (stored under projects/) and then do some assertions on the build output.
See an example for a unit test and an integration test.
Commit Message Guidelines
- Start with the bug number the change is related to; don't add "bug" or puctuation marks
- Also in the first line, provide a clear and concise description of the change
- Add one blank line, followed by more details about the change. This could include a motivation for the change and/or reasons why things were done in the particular way they are done in the change.
- Add "Bug: <bug number>" in the footer.
- Add "Signed-off-by: <your_email_adress>" in the footer (see "Legal Paperwork" below).
See here for an example commit message
Commit Granularity
- Make small commits, yet self-contained commits. This makes them easy to review.
- Do not mix concerns in commits: have a commit do a single thing. This makes them reviewable 'in isolation'. This is particularly important if you need to do refactorings to the existing code: Refactorings tend to lead to large diffs which are difficult to review. Therefore make sure to have separate commits for refactorings and for functional changes.
Contributing the Patch
Legal Paperwork
Before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Foundation Contributor License Agreement (CLA) and sign off on the Eclipse Foundation Certificate of Origin.
Follow the instructions on Development_Resources/Handling Git Contributions
In general, also see Development Resources#Users: Contributing To A Project.
Pushing to Gerrit
The Eclipse Gerrit is the preferred way to propose patches to Tycho. Everyone with an Eclipse Bugzilla login can propose patches.
In order to propose a change to Tycho
- Configure the repository URL https://git.eclipse.org/r/tycho/org.eclipse.tycho for the remote "origin"
- Know your Gerrit HTTPS user name and password
- Push to the special code review branch "refs/for/master", e.g. with git push origin HEAD:refs/for/master
For more information on the Eclipse Gerrit instance (e.g. how to push via SSH), see here: Gerrit.
Note that prototypes and other incomplete work should be clearly marked as such e.g. by adding "POC" or "WIP" in the commit message, by commenting in Gerrit, or by pushing to the refs/for/master/POC topic branch. This avoids that committers spend time on reviewing incomplete changes.