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 "Scout/Contribution"
(→Bug Quality Matters) |
(→Bug Quality Matters) |
||
| Line 42: | Line 42: | ||
: <i>I wand to create a new plugin in Eclipse using CDT. Shall it possible. | : <i>I wand to create a new plugin in Eclipse using CDT. Shall it possible. | ||
| − | : I had made a R&D in eclipse documentation. I had | + | : I had made a R&D in eclipse documentation. I had get an idea about create a |
| − | + | : plugin using Java. But i wand to create a new plugin ( user defined plugin ) | |
| − | + | : using CDT. After that I wand to impliment it in my programe. If it possible?. | |
| − | + | ||
: Any one can help me please...</i> | : Any one can help me please...</i> | ||
Revision as of 11:17, 8 June 2011
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.
Contents
Introduction
The 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. The Scout documentation has been moved to https://eclipsescout.github.io/. it, go through The Scout documentation has been moved to https://eclipsescout.github.io/., 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 Scout Forum
- Report these bugs/enhancements via 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
1) Before you do anything related to bugs please have a look at the Eclipse Bugzilla FAQ.
2) Before you open a new Scout 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:
When you cannot find an existing bug, feel free to open a new bug:
Below there are some specific guidelines on how to provide valuable information together with your bug summary
Bug Quality Matters
High quality bugs help to quickly understand/analyize/fix bugs. Bad quality bugs lead to poor developer morale and slow down everything. Good quality bugs often feature many of the following tings:
- Steps to reproduce
- Stack traces
- Source file and line numbers from attempts to locate the source of the bug
Lack of any of these is considered poor quality. A drastic example (taken from [1]) reads as follows:
- I wand to create a new plugin in Eclipse using CDT. Shall it possible.
- I had made a R&D in eclipse documentation. I had get an idea about create a
- plugin using Java. But i wand to create a new plugin ( user defined plugin )
- using CDT. After that I wand to impliment it in my programe. If it possible?.
- Any one can help me please...
Good guidelines on how to write a bug may be found here:
[1] Nicolas Bettenburg et al. "Quality of bug reports in Eclipse", Proceedings of the 2007 OOPSLA workshop on eclipse technology eXchange, 2007
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 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 Bugzilla entry with a patch attached.