Difference between revisions of "Scout/Contribution"

From Eclipsepedia

Jump to: navigation, search
(Getting the Scout Sources)
(Past Nominations)
(4 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
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 [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:
+
The typical Eclipse Scout 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 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 will find bugs, or have ideas for your great feature.  
Line 125: Line 125:
 
* Status 'Assigned' may be skipped
 
* Status 'Assigned' may be skipped
 
* For a bug in status 'Resolved' the 'Target Milestone' must be specified
 
* For a bug in status 'Resolved' the 'Target Milestone' must be specified
 +
<!-- TODO: check this: Not necessary since the migration to git?
 
* 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
 
* 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
 
* 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
 
* 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
 
* Bugs are closed by Scout project leads after a release is shipped
  
=== Checklist for setting status to Resolved (Fixed) ===
+
 
 +
== [Contributor] After starting to work on a Bug ==
 +
 
 +
A good practice is to assign the bug to the person working on the bug. This way everybody knows someone is working on the bug.
 +
 
 +
* Change the status to "ASSIGNED"
 +
* Target milestone where you plan to fix the Bug (corresponding to the develop branch). If the fix should also be backported to a previous branch, indicate this in the comment.
 +
 
 +
 
 +
== [Contributor] After having pushed to Gerrit ==
 +
 
 +
In Bugzilla [OPTIONAL]
 +
* Comment: Link to Gerrit change
 +
 
 +
In Gerrit [MANDATORY]
 +
* Wait for the Hudson build (+1 Verified)
 +
* Review: (+2 Code-Review; +1 IP-Clean)
 +
** ping (mail, forum, phonecall...) a commiter to get a review. Nobody looks in the Gerrit Inbox for open changes.
 +
** if you are commiter, it is allowed to review your own change. A good practice is to speak about it with an other commiter.
 +
 
 +
 
 +
== [Commiter] After having submitted the change in Gerrit ==
 +
After having submitted the Gerrit change in Gerrit, the commiter should:
 +
 
 +
In Bugzilla [MANDATORY]
 +
* Add a comment in Bugzilla: „Pushed to develop with commit + URL”
 +
  <nowiki>http://git.eclipse.org/c/scout/org.eclipse.scout.rt.git/commit/?id={{commit}}</nowiki>
 +
* Check the Target Milestone.
 +
* Change Satus to: “RESOLVED FIXED”
 +
* Asign the Bug to a Tester “Could you verify please?”
 +
 
 +
=== Checklist for setting status to RESOLVED FIXED ===
 +
<!-- TODO: check this: Not necessary since the migration to git?
 
* Iplog is set, if necessary (on patch not ticket, if a patch is available)
 
* Iplog is set, if necessary (on patch not ticket, if a patch is available)
 +
-->
 
* Milestone is correct
 
* Milestone is correct
 
* Ticket contains migration notes, if necessary
 
* Ticket contains migration notes, if necessary
Line 138: Line 173:
 
* News entry is written in [[Scout/NewAndNoteworthy]], if necessary (for enhancements and other important changes)
 
* 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.
+
== [Tester] After having tested ==
* 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.
+
''' How do I test?'''
 +
 
 +
Now is a good time to (re)read the bugzilla and verify that the implemented solution actually solves the problem(s).
 +
 
 +
Please test the change in a Scout application. The binary form (.jar) should be tested (continuous job, milestone release...)
 +
 
 +
Test on all branches where the ticket was applied.
 +
 
 +
''' How do I report the results?'''
 +
 
 +
In Bugzilla [MANDATORY]
 +
* Comment: „Tested with version XXXXX” (for example <tt>3.10.0.20131003-1140</tt>) (see [[#Find_the_version_of_a_plugin]])
 +
* Change “Status” and “Assigned to”:
 +
* If the ticket is ok set the status to "VERIFIED FIXED" and reassign it to the default assignee (see [[#Reset_assignee_to_default]]).
 +
* If the ticket was not ok, set the status to "REOPENED" and reassign it to the person who solved the ticket. Explain what is wrong in the comment.
 +
 
 +
 
 +
=== Find the version of a plugin ===
 +
With CTRL-Shift-A you can look for any scout bundle in your target platform. Select the bundle that should contain your modification. Click OK.
 +
 
 +
[[File:Open_Plug-in_Artifact.png]]
 +
 
 +
In the Manifest editor, you can copy the exact version. The timestamp you see in the version is corresponding to the last commit for this bundle.
 +
 
 +
[[File:Copy_version_from_Manifest_editor.png]]
 +
 
 +
 
 +
=== Reset assignee to default ===
 +
Use the Bugzilla feature to reassign the assignee to default.
 +
 
 +
[[File:Bugzilla_reset_assignee_to_default.png]]
  
 
= Contributions for Non-Scout Committers =
 
= Contributions for Non-Scout Committers =
Line 365: Line 430:
  
 
== Current Nominations ==
 
== Current Nominations ==
 +
 +
== Past Nominations ==
 
* [[Scout/Scout_Nomination_CSC|Christoph Schwank]], May 2013
 
* [[Scout/Scout_Nomination_CSC|Christoph Schwank]], May 2013
 
* [[Scout/Scout_Nomination_OSC|Oli Schmid]], May 2013
 
* [[Scout/Scout_Nomination_OSC|Oli Schmid]], May 2013
 
* [[Scout/Scout_Nomination_BKO|Bruno Koeferli]], May 2013
 
* [[Scout/Scout_Nomination_BKO|Bruno Koeferli]], May 2013
 
== Past Nominations ==
 
 
* [[Scout/Scout_Nomination_AMO|Adrian Moser]], Dezember 2012
 
* [[Scout/Scout_Nomination_AMO|Adrian Moser]], Dezember 2012
 
* [[Scout/Scout_Nomination_BSH|Beat Schwarzentrub]], Dezember 2012
 
* [[Scout/Scout_Nomination_BSH|Beat Schwarzentrub]], Dezember 2012

Revision as of 05:40, 26 November 2013

Contents

Introduction

The Eclipse wiki gives a good detailed overview of the various ways you can contribute to a project:

The typical Eclipse Scout contributor will go through the following steps:

  1. You use Scout, i.e. install it, go through tutorials, build your own Scout apps
  2. You will find bugs, or have ideas for your great feature.
  3. You provide some public feedback
    1. Read/ask questions on the Scout Scout Forum
    2. Report these bugs/enhancements via Scout bugzilla
  4. Eventually, you might want to speed up bug fixing by providing patches
  5. Getting enthusiastic enough, you will contribute many valuable, high quality patches for Scout bugs/enhancements
  6. 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

  1. New
  2. Assigned
  3. Resolved (Fixed)
  4. Verified
  5. Closed

Some notes:

  • Status 'Assigned' may be skipped
  • For a bug in status 'Resolved' the 'Target Milestone' must be specified
  • 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


[Contributor] After starting to work on a Bug

A good practice is to assign the bug to the person working on the bug. This way everybody knows someone is working on the bug.

  • Change the status to "ASSIGNED"
  • Target milestone where you plan to fix the Bug (corresponding to the develop branch). If the fix should also be backported to a previous branch, indicate this in the comment.


[Contributor] After having pushed to Gerrit

In Bugzilla [OPTIONAL]

  • Comment: Link to Gerrit change

In Gerrit [MANDATORY]

  • Wait for the Hudson build (+1 Verified)
  • Review: (+2 Code-Review; +1 IP-Clean)
    • ping (mail, forum, phonecall...) a commiter to get a review. Nobody looks in the Gerrit Inbox for open changes.
    • if you are commiter, it is allowed to review your own change. A good practice is to speak about it with an other commiter.


[Commiter] After having submitted the change in Gerrit

After having submitted the Gerrit change in Gerrit, the commiter should:

In Bugzilla [MANDATORY]

  • Add a comment in Bugzilla: „Pushed to develop with commit + URL”
 http://git.eclipse.org/c/scout/org.eclipse.scout.rt.git/commit/?id={{commit}}
  • Check the Target Milestone.
  • Change Satus to: “RESOLVED FIXED”
  • Asign the Bug to a Tester “Could you verify please?”

Checklist for setting status to RESOLVED FIXED

  • 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)


[Tester] After having tested

How do I test?

Now is a good time to (re)read the bugzilla and verify that the implemented solution actually solves the problem(s).

Please test the change in a Scout application. The binary form (.jar) should be tested (continuous job, milestone release...)

Test on all branches where the ticket was applied.

How do I report the results?

In Bugzilla [MANDATORY]

  • Comment: „Tested with version XXXXX” (for example 3.10.0.20131003-1140) (see #Find_the_version_of_a_plugin)
  • Change “Status” and “Assigned to”:
  • If the ticket is ok set the status to "VERIFIED FIXED" and reassign it to the default assignee (see #Reset_assignee_to_default).
  • If the ticket was not ok, set the status to "REOPENED" and reassign it to the person who solved the ticket. Explain what is wrong in the comment.


Find the version of a plugin

With CTRL-Shift-A you can look for any scout bundle in your target platform. Select the bundle that should contain your modification. Click OK.

Open Plug-in Artifact.png

In the Manifest editor, you can copy the exact version. The timestamp you see in the version is corresponding to the last commit for this bundle.

Copy version from Manifest editor.png


Reset assignee to default

Use the Bugzilla feature to reassign the assignee to default.

Bugzilla reset assignee to default.png

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:

  1. make sure the patch doesn't contain cryptography
  2. make sure the patch is written from scratch
  3. make sure the patch is submitted under the EPL
  4. 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

Please refer to Scout/Contributions_for_Scout_Committers


Getting the Scout Sources

Starting with Scout 3.9.0 (Kepler) we are using git at eclipse: [1]. The sources for earlier releases are still available on SVN. How to setup your environment to compile the sources and contribute see Setup.

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 branching policy is described here: Git Branching Policy.

Webviewer:

Luna

 Eclipse Scout 3.10.0 (upcoming Luna Release)
 Branch: develop

Kepler

 Eclipse Scout 3.9.2 (upcoming Kepler SR2)
 Branch: release/3.9.2 (view RT repository - view SDK repository)
 Eclipse Scout 3.9.1 (Kepler SR1)
 Branch: master
 Tag: Kepler_SR1_RC4 (view RT repository - view SDK repository)
 Eclipse Scout 3.9.0 (Kepler)
 Branch: master
 Tag: Kepler_RC4 (view RT repository - view SDK repository)

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.2 (Juno SR2) 
 Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/tags/2013-02-11_S-3.8.2RC4
 SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/tags/2013-02-11_S-3.8.2RC4
 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 
}}
Note.png
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

Past Nominations