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"
(define "reasonably small" for commits; drop redundant sentence) |
(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) |
||
| Line 1: | Line 1: | ||
| − | == | + | == 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 [https://bugs.eclipse.org/bugs/query.cgi?format=specific;product=Tycho 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 [mailto:tycho-dev@eclipse.org 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]] . | ||
| − | |||
If the patch is not trivial, make sure you include a test case that reproduces the bug or proves that the enhancement works. | If the patch is not trivial, make sure you include a test case that reproduces the bug or proves that the enhancement works. | ||
| Line 16: | Line 21: | ||
=== Commit Message Guidelines === | === 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. | |
| − | + | ||
See an [http://git.eclipse.org/c/tycho/org.eclipse.tycho.git/commit/?id=713962c047eb048223d711c62bdb418931172890 example commit message] | See an [http://git.eclipse.org/c/tycho/org.eclipse.tycho.git/commit/?id=713962c047eb048223d711c62bdb418931172890 example commit message] | ||
| Line 32: | Line 36: | ||
=== Using Gerrit === | === Using 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. If you haven't worked with Gerrit before, you should read [[Gerrit#User_Account|this introduction]]. | |
| − | + | ||
| − | The push | + | The push URLs for the Tycho repository are |
| + | * (via ssh) <tt>ssh://<username>@git.eclipse.org:29418/tycho/org.eclipse.tycho.git</tt> | ||
| + | * (via https) <tt>https:</tt><tt>//git.eclipse.org/r/p/tycho/org.eclipse.tycho.git</tt> | ||
| − | + | === Using Bugzilla === | |
| − | + | Attach the patch(es) to the bug/enhancement in Bugzilla. The patch should be in the format produced by <tt>git format-patch</tt>, so that it is suitable for <tt>git am</tt>. | |
| − | === | + | === Legal Paperwork === |
| − | + | ||
| − | With the contribution, you will have to include answers to the following questions: | + | With the contribution, you will have to include answers to the following questions (e.g. as comment in Gerrit or Bugzilla): |
# Did you author 100% of the content you are contributing? | # Did you author 100% of the content you are contributing? | ||
| Line 52: | Line 56: | ||
With these questions answered, we will be able to accept small patches (<250 LoC) immediately. For larger patches, we will also have to create a contribution questionnaire for review by the Eclipse IP team, but this usually doesn't require additional actions from you. | With these questions answered, we will be able to accept small patches (<250 LoC) immediately. For larger patches, we will also have to create a contribution questionnaire for review by the Eclipse IP team, but this usually doesn't require additional actions from you. | ||
| + | |||
| + | In general, also see [[Development Resources#Users: Contributing To A Project]]. | ||
[[Category:Tycho|Contributor Guide]] | [[Category:Tycho|Contributor Guide]] | ||
Revision as of 04:31, 20 April 2012
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 .
If the patch is not trivial, make sure you include a test case that reproduces the bug or proves that the enhancement works.
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.
See 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
Using Gerrit
The Eclipse Gerrit is the preferred way to propose patches to Tycho. Everyone with an Eclipse Bugzilla login can propose patches. If you haven't worked with Gerrit before, you should read this introduction.
The push URLs for the Tycho repository are
- (via ssh) ssh://<username>@git.eclipse.org:29418/tycho/org.eclipse.tycho.git
- (via https) https://git.eclipse.org/r/p/tycho/org.eclipse.tycho.git
Using Bugzilla
Attach the patch(es) to the bug/enhancement in Bugzilla. The patch should be in the format produced by git format-patch, so that it is suitable for git am.
Legal Paperwork
With the contribution, you will have to include answers to the following questions (e.g. as comment in Gerrit or Bugzilla):
- Did you author 100% of the content you are contributing?
- Who owns the copyright of the contributed content? (This is typically your employer.)
- Is the contributed code licensed under the EPL? (You should answer this question by putting a copyright and license header into every new java file.)
- Do you have the right to contribute the content to Eclipse? (You need to confirm this with the copyright owner.)
With these questions answered, we will be able to accept small patches (<250 LoC) immediately. For larger patches, we will also have to create a contribution questionnaire for review by the Eclipse IP team, but this usually doesn't require additional actions from you.
In general, also see Development Resources#Users: Contributing To A Project.