Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Tycho/Contributor Guide"

m
(Replaced content with "See https://github.com/eclipse/tycho/blob/master/CONTRIBUTING.md")
 
(38 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== How to contribute patches to Tycho ==
+
See https://github.com/eclipse/tycho/blob/master/CONTRIBUTING.md
 
+
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 [[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 ==
+
 
+
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]]
+

Latest revision as of 18:36, 8 April 2021

See https://github.com/eclipse/tycho/blob/master/CONTRIBUTING.md

Copyright © Eclipse Foundation, Inc. All Rights Reserved.