|
|
| (195 intermediate revisions by 15 users not shown) |
| Line 1: |
Line 1: |
| − | {{:DocumentationGuidelines/DraftHeader}}
| + | We are now on GitHub! You'll find the new contribution guide here: https://github.com/eclipse-scout/scout.rt#contributing |
| − | | + | |
| − | = Introduction =
| + | |
| − | | + | |
| − | The [http://wiki.eclipse.org/Development_Resources#Users:_Contributing_To_A_Project Eclipse wiki] gives a good detailed overview of the various ways you can contribute to a project:
| + | |
| − | | + | |
| − | The typical contributor will go through the following steps:
| + | |
| − | # You use Scout, i.e. {{ScoutLink|HowTo|Install Scout SDK|install}} it, go through {{ScoutLink|Tutorial|name=tutorials}}, build your own Scout apps
| + | |
| − | # You will find bugs, or have ideas for your great feature.
| + | |
| − | # You provide some public feedback
| + | |
| − | ## Read/ask questions on the Scout [http://www.eclipse.org/forums/eclipse.scout Scout Forum]
| + | |
| − | ## Report these bugs/enhancements via [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;product=Scout Scout bugzilla]
| + | |
| − | # Eventually, you might want to speed up bug fixing by providing patches
| + | |
| − | # Getting enthusiastic enough, you will contribute many valuable, high quality patches for Scout bugs/enhancements
| + | |
| − | # Now is the time to start the committer election process :-)
| + | |
| − | | + | |
| − | = Opening new Bugs =
| + | |
| − | | + | |
| − | Before you do anything related to searching / opening Scout bugs you might want to have a look at the [http://wiki.eclipse.org/Bug_Reporting_FAQ Eclipse Bugzilla FAQ].
| + | |
| − | | + | |
| − | Before you open a new bug, please try to scan through the known bugs to verify that you are not reporting a bug that is already known for Eclipse Scout.
| + | |
| − | | + | |
| − | For your convenience a number of links are provided below:
| + | |
| − | | + | |
| − | * [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;bug_status=RESOLVED;bug_status=VERIFIED;product=Scout All open Scout bugs]
| + | |
| − | * [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;product=Scout All Scout bugs]
| + | |
| − | | + | |
| − | When you cannot find an existing bug, feel free to open a new bug:
| + | |
| − | | + | |
| − | [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Scout Open a new Scout bug]
| + | |
| − | | + | |
| − | Below there are some Scout specific guidelines on how to provide valuable information together with your bug summary
| + | |
| − | | + | |
| − | == Choose the proper Component ==
| + | |
| − | | + | |
| − | Select the component according to the following criteria
| + | |
| − | * '''Scout''': Scout Runtime bugs, or anyting else that you are not sure what component to choose
| + | |
| − | * '''Scout SDK''': Bugs in the Scout SDK, e.g. wizards that create code that won't compile
| + | |
| − | * '''Scout Docs''': Bugs on www.eclipse.org/scout, wiki.eclipse.org/scout, and any other public communication regarding Scout
| + | |
| − | | + | |
| − | == Use a decent Summary line ==
| + | |
| − | | + | |
| − | bla
| + | |
| − | | + | |
| − | == Provide enough information to reproduce the bug ==
| + | |
| − | | + | |
| − | = Development IDE Configuration =
| + | |
| − | | + | |
| − | Scout has Java 5.0 and Eclipse Platform 3.5 as minimum requirements, so dependencies to newer Java and platform versions must be avoided.
| + | |
| − | | + | |
| − | In order to minimize the inadvertent introduction of dependencies to Java 6.0, add both a Java5 and a Java 6 SDK to your workspace. Do this in Window/Preferences -> Java/Installed JREs. Then configure your Execution Environments so that J2SE-1.5 refer to a Java 5 SDK and JavaSE-1.6 refer to a Java 6 installation.
| + | |
| − | | + | |
| − | If you are using OS X Snow Leopard, then Java 5 is hard to find. Using the search button in Eclipse will tell you that you have a 1.5.0 version of Java. That is probably a lie. It is just a link to 1.6. Fortunately some nice guys have made a download that you may use. Follow these [http://wiki.oneswarm.org/index.php/OS_X_10.6_Snow_Leopard instructions] to download and installl a real Java 5. You do '''not''' need to make it default. Downloading, unpacking and fixing the version links is enough.
| + | |
| − | | + | |
| − | = Getting the Scout Sources =
| + | |
| − | | + | |
| − | You may download the Eclipse Scout sources from eclipse.org
| + | |
| − | | + | |
| − | http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/
| + | |
| − | | + | |
| − | = Contributing Patches =
| + | |
| − | | + | |
| − | Please create a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Scout Bugzilla] entry with a patch attached.
| + | |
| − | | + | |
| − | = More to come ... =
| + | |
