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"
m |
m |
||
| Line 16: | Line 16: | ||
== Patch Format == | == Patch Format == | ||
| − | We prefer git patches created with [http://schacon.github.com/git/user-manual.html#submitting-patches git format-patch] since they | + | We prefer git patches created with [http://schacon.github.com/git/user-manual.html#submitting-patches git format-patch] since they include a commit message and preserve author information. This will also give you the credit you deserve in the git history. |
== Contributing the Patch == | == Contributing the Patch == | ||
Revision as of 09:39, 9 December 2011
Contents
How to contribute patches to Tycho
First, read Developing Tycho .
If you want to do an enhancement but don't know where to start or if it's going in the right direction, just ask on tycho-dev@eclipse.org and we will help. 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.
Patch Format
We prefer git patches created with git format-patch since they include a commit message and preserve author information. This will also give you the credit you deserve in the git history.
Contributing the Patch
Open a bug and attach the patch. This is the only channel we can accept patches (until we may be able to use gerrit for accepting patches at some point in the future).
You will have to include answers to the following questions:
- Did you author 100% of the content you are contributing ?
- Do you have the rights to donate the content to Eclipse ?
- Are you contributing the content under the EPL ?
For larger patches (>250 LoC) we will also have to create a contribution questionnaire with the Eclipse IP team.
In general, also see Development Resources#Users: Contributing To A Project.