Difference between revisions of "Tycho/Contributor Guide"

From Eclipsepedia

Jump to: navigation, search
m
m
Line 1: Line 1:
 
== How to contribute patches to Tycho ==
 
== 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.
+
First, read [[Developing Tycho]] .
If you want to provide a patch for a bug, make sure you include a test case that reproduces the bug.
+
 
 +
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 [[mailto: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 ehhancement works.
 +
 
 +
== Writing Tests ==
 +
Tycho has two types of tests: unit tests (locally in each module) and a global integration test suite in 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 use maven to build a sample project and then do some assertions on the build output.
 +
 
 +
See examples for unit tests and integration tests.
  
 
== Patch Format ==
 
== Patch Format ==
  
We prefer git patches created with git format-patch since they preserve a commit message as well as author information. This gives you the credit you deserve in the git history.
+
We prefer git patches created with [[git format-patch|http://schacon.github.com/git/user-manual.html#submitting-patches]] since they preserve a commit message as well as author information. This gives you the credit you deserve in the git history.
  
  
 
[[Category:Tycho|Contributor Guide]]
 
[[Category:Tycho|Contributor Guide]]

Revision as of 09:15, 9 December 2011

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 [[1]] 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 ehhancement works.

Writing Tests

Tycho has two types of tests: unit tests (locally in each module) and a global integration test suite in 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 use maven to build a sample project and then do some assertions on the build output.

See examples for unit tests and integration tests.

Patch Format

We prefer git patches created with http://schacon.github.com/git/user-manual.html#submitting-patches since they preserve a commit message as well as author information. This gives you the credit you deserve in the git history.