Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Scout/Contribution"
(→Step 1: Clone GIT repository) |
(→Step 1: Clone GIT repository) |
||
Line 186: | Line 186: | ||
In your Eclipse IDE click on ''Windows -> Open Perspective -> Others...'' and select Git Repository Exploring. | In your Eclipse IDE click on ''Windows -> Open Perspective -> Others...'' and select Git Repository Exploring. | ||
− | [[Image: | + | [[Image:GitContribution.01.select.git.perspective.png]] |
= Development IDE Configuration = | = Development IDE Configuration = |
Revision as of 08:23, 1 July 2013
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. See next section.
Find Existing Scout Bugs
For your convenience a number of links are provided below:
Bug Report Quality Matters
High quality bug reports help to quickly understand/analyze/fix bugs. Bad quality bug reports lead to poor developer morale and slow down everything.
Good quality bug reports often feature many of the following things:
- Well organized description
- Clear distinction between observed behaviour and expected behaviour
- Steps to reproduce
- Stack traces
- Screenshots
- Source file and line numbers from attempts to locate the source of the bug
Lack of any of the above characteristics 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...
[1] Nicolas Bettenburg et al. "Quality of bug reports in Eclipse", Proceedings of the 2007 OOPSLA workshop on eclipse technology eXchange, 2007
Good guidelines on how to write a bug may be found here:
Open a Scout bug
When you cannot find an existing bug, feel free to open a new bug:
Please also read the text below that introduces some Scout specific aspects of bug writing
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
Choose the proper Version
Choose the Scout version that you are having the issue with. Next the Scout release coming with Kepler (june 2013) this would be 3.9.0.
If you are using an older version of Eclipse Scout, there is no more release planned, but relevant bugs will still be fixed on these branches.
Choose the proper Severity
Severity is assigned by a user and describes the level of impact the bug is having on them, the Eclipse Scout project has defined following meanings:
Severity | Definition | Used when |
---|---|---|
Blocker | Prevents function from being used, no work-around, blocking progress on multiple fronts | The bug prevents use or testing of the build |
Critical | Prevents function from being used, no work-around | frequent crashes, “loss of data” |
Major | Prevents function from being used, but a work-around is possible | “loss of function” |
Normal | A problem making a function difficult to use but no special work-around is required | default value, typically the correct setting unless one of the other levels fit |
Minor | A problem not affecting the actual function, but the behavior is not natural (or it is not important). | something's wrong, but it doesn't affect the function significantly |
Trivial | A problem not affecting the actual function, a typo would be an example | feature requests, nice to have (also when the new feature is “major”) |
Use a decent Summary line
Helps a lot to identify the bug in a large list of bugs. Good example: SWT: Columns with an active filter should be identifiable. Bad example: Layout.
In case the bug relates to a specific Scout runtime UI please use one of the following prefixes:
- Swing:: For bugs specific to the Scout Swing UI
- SWT:: For bugs specific to the Scout SWT UI
Bug Life Cycle
Consult the Eclipse wiki for a diagram showing the possible bug live cycles.
Typical Life Cycle
- New
- Assigned
- Resolved (Fixed)
- Verified
- Closed
Some notes:
- Status 'Assigned' may be skipped
- For a bug in status 'Resolved' the 'Target Milestone' must be specified
- If a patch contributed by a non-committer is applied, set the iplog flag to '+' (on the individual patch file, not on the bug!) and follow the guidelines in section below
- Ideally, the implementation/Fix is verified by the person opening the bug
- If bug and implementation is from the same person, someone else should verify the bug
- Bugs are closed by Scout project leads after a release is shipped
Checklist for setting status to Resolved (Fixed)
- Iplog is set, if necessary (on patch not ticket, if a patch is available)
- Milestone is correct
- Ticket contains migration notes, if necessary
- Whiteboard contains migration text, if necessary
- Ticket is assigned to person that is supposed to test it
- News entry is written in Scout/NewAndNoteworthy, if necessary (for enhancements and other important changes)
Verifying a ticket
- Test, if the original problem was solved and it is save to close it. Test on all branches where the ticket was applied.
- If the ticket is ok set the status to "VERIFIED" and reassign it to the default assignee
- If the ticket was not ok, set the status to "REOPENED" and reassign to the person who solved the ticket.
Contributions for Non-Scout Committers
Contributing patches
Please create a Bugzilla entry with a patch attached. Some guidelines on how to create such a patch can be found in the following Eclipse article (specifically the sections 'Fixing the Bug' and 'Submitting a Patch').
Contribution to the Eclipse Scout project needs to follow the coding guidelines.
To successfully contribute you also have to follow the Eclipse legal guidelines.
Specifically, you need to:
- make sure the patch doesn't contain cryptography
- make sure the patch is written from scratch
- make sure the patch is submitted under the EPL
- make sure the change is less than 250 lines of code
Special cases
- If you're employed outside of bsi, you will need to explicitly confirm all above points in the gerrit change or in the bugzilla ticket
- If your contribution is larger than 250 lines of code we need to fill in a contribution questionnaire and open a corresponding IPZilla bug
- If the licence is not EPL we will need to have this verified (e.g GPL is a no-go)
I have provided a Patch. Now What?
If you have attached a patch to a bugzilla ticket and are not satisfied with it's progress (read: nobody seems to notice after a week or so): Nudge us in the Scout forum, and please allow for some more days. We will then find a committer for your bug and figure out the next steps together.
To list the currently pending patches you may use this query
Contributions for Scout Committers
Contributing a patch or feature
Summary
Contributing a patch or a new feature to Eclipse Scout Kepler or Luna is done by creating a new feature branch that will be merged into the corresponding develop (currently Luna) or release branch (release/3.9.1 is Kepler SR1). In this chapter all necessary steps are shown to contribute a patch or a feature. This example requires EGIT to be installed in the Eclipse IDE.
Step 1: Clone GIT repository
All Eclipse Scout GIT repositories are listed here. In this example, we'll provide a new feature to the Scout Runtime. Therefore, we clone the Scout RT repository is cloned.
In your Eclipse IDE click on Windows -> Open Perspective -> Others... and select Git Repository Exploring.
Development IDE Configuration
Scout has Java 6.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 7.0, add both a Java6 and a Java 7 SDK to your workspace. Do this in Window/Preferences -> Java/Installed JREs. Then configure your Execution Environments so that J2SE-1.6 refer to a Java 6 SDK and JavaSE-1.7 refer to a Java 7 installation.
Getting the Scout Sources
Starting with Scout 3.9.0 (Kepler) we are using git. See: http://git.eclipse.org/c/scout/.
The Scout documentation has been moved to https://eclipsescout.github.io/..
Repositories
Runtime: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.rt.git SDK: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.sdk.git
The sources for earlier releases are still available on SVN (see section Juno or Indigo). You may browse the SVN repository online.
Luna
Eclipse Scout 3.10.0 (upcoming Luna Release) Branch: develop
Kepler
Eclipse Scout 3.9.1 (upcoming Kepler SR1) Branch: release/kepler_sr1
Eclipse Scout 3.9.0 (Kepler) Branch: master
Juno
The most current state of the Juno release of Eclipse Scout is
Eclipse Scout 3.8.x (Juno) Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/branches/3.8 SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/branches/3.8
To get access to the sources of the Juno release you may access the repository through the tags provided below.
Eclipse Scout 3.8.1 (Juno SR1) Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/tags/2012-09-17_S-3.8.1 SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/tags/2012-09-17_S-3.8.1
Eclipse Scout 3.8.0 (Juno) Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/tags/2012-06-13_S-3.8.0RC4 SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/tags/2012-06-13_S-3.8.0RC4
Indigo
The most current state of the Indigo branch of Eclipse Scout is
Eclipse Scout 3.7.x (Indigo) Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/branches/2011-Jun SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/branches/2011-Jun
To get access to the sources of the Indigo release you may access the repository through the tags provided below.
Eclipse Scout 3.7.2 (Indigo SR2) Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/tags/2012-02-14_S-3.7.2RC4/ SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/tags/2012-02-14_S-3.7.2RC4/
Eclipse Scout 3.7.1 (Indigo SR1) Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/tags/2011-09-14_S-3.7.1RC4 SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/tags/2011-09-14_S-3.7.1RC4
Eclipse Scout 3.7.0 (Indigo) Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/tags/2011-06-06_S-3.7.0RC4 SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/tags/2011-06-06_S-3.7.0RC4
Wiki Contribution
We encourage Eclipse Scout developers and contributors to take the "better to ask for forgiveness than permission" approach to adding and updating wiki documentation.
Create links
Forum to Wiki
A forum thread has a very short life time (sometimes some user use the search engine, but it is not always the case). As forum threads As a wiki page has a much longer lifetime than a forum thread, it is a good practice to increase the value of the information accumulated in a forum thread by condensing it into a wiki page. Its value is further growing over time because – in contrast to information in a forum thread - it is much more likely that the information in the wiki is kept up to date. When a Forum Topic is summarized into a wiki page or pages, it is a good practice to let the forum readers know about it. (This helps people that find an old forum thread via search engines). The above recommendation does not apply to all forum threads, but often it’s already clear from the first question in a new thread if the asked for information would be a valuable addition to the wiki. To make the process more efficient we like to suggest the following approach. Once it’s clear that the question is of a conceptual nature and it will take some time to compile a good answer consider to first create the answer as a how-to entry or a concept entry in the wiki. Then answer the forum’s question by adding a link to the newly created wiki page.
Wiki to Forum
Sometime there is a very good discussion in the forum (example, how to, architecture description, advanced topic explanations). Such valuable know how belongs to the wiki, but it is sometimes not possible to control where the discussion takes place. If there is/are (roughly) matching existing wiki pages but the person responding the forum thread does not have the necessary time to amend this existing wiki at least add a link from the wiki page to the forum thread.
What you type | What you see |
---|---|
{{note|TODO|Merge the content of this post: build your own fragment containing the MySql jdbc driver http://www.eclipse.org/forums/index.php/mv/msg/214013/691589/#msg_691589 }} |
Wiki to Wiki
A wiki is not a book, it is not linear. It is not possible to assume where a reader will start reading (he might land on a page with a search engine). Therefore it is important to link the pages together. We try to add a “see also” section on each page. It is the default solution to link pages with each other.
It is possible to check how many other wiki pages contain a link to a page. Link “What links here” from the Toolbox section. At list 2-3 pages should reference a new page.
Use MediaWiki Features
Java Syntax highlighting
Tag the code blocks with source tag
What you type | What you see |
---|---|
<source lang="java"> @Override protected IPage execCreateChildPage(final ITableRow row) throws ProcessingException { MyNodePage childPage = new MyNodePage(); childPage.setId(getTable().getIDColumn().getValue(row)); return childPage; } </source> |
@Override protected IPage execCreateChildPage(final ITableRow row) throws ProcessingException { MyNodePage childPage = new MyNodePage(); childPage.setId(getTable().getIDColumn().getValue(row)); return childPage; } |
<source lang="xml"> <filter aliases="/process" class="org.eclipse.scout.http.servletfilter.security.LDAPSecurityFilter" ranking="50"> </filter> </source> |
<filter aliases="/process" class="org.eclipse.scout.http.servletfilter.security.LDAPSecurityFilter" ranking="50"> </filter> |
<source lang="sql"> select language_id, name from languages </source> |
SELECT language_id, name FROM languages |
Committer Nominations
Nominations for committer status can be created in the committer portal. Nominations should follow the according to the Eclipse wiki guidlines. A good starting point for nominations is a significant number (8-15) of well written patches, meaningful posts on the Scout forum and other community activities. To count patches we typically use the Scout IP Log.
Preparing Nominations
Current Nominations
- Christoph Schwank, May 2013
- Oli Schmid, May 2013
- Bruno Koeferli, May 2013
Past Nominations
- Adrian Moser, Dezember 2012
- Beat Schwarzentrub, Dezember 2012
- Jeremie Bresson, Dezember 2012
- Ken Lee, August 2012
- Stephan Merkli, August 2012
- Matthias Villiger, September 2011
- Claudio Guglielmo, September 2011