Jump to: navigation, search

Difference between revisions of "Scout/Contribution"

(Juno)
(Committer Nominations)
(30 intermediate revisions by 6 users not shown)
Line 87: Line 87:
 
* 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
* If a patch contributed by a non-committer is applied, set the '''iplog flag to '+'''' 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) ===
 +
* 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)
  
 
= Contributing Patches  =
 
= Contributing Patches  =
  
Please create a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Scout Bugzilla] entry with a patch attached.
+
Please create a [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Scout Bugzilla] entry with a patch attached. Some guidelines on how to create such a patch can be found in the [http://www.eclipse.org/articles/article.php?file=Article-How-to-Fix-a-Bug-in-Eclipse/index.html following Eclipse article] (specifically the sections 'Fixing the Bug' and 'Submitting a Patch').
 +
 
 +
Contribution to the Eclipse Scout project needs to follow the [[Scout/Coding_Guidelines|coding guidelines]].
  
 
To successfully contribute you also have to follow the Eclipse [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf legal guidelines].
 
To successfully contribute you also have to follow the Eclipse [http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf legal guidelines].
Line 105: Line 115:
  
 
Special cases
 
Special cases
* If you're employed outside of [http://www.bsiag.com bsi], you will need to explicitly confirm all above points in the bugzilla ticket
+
* If you're employed outside of [http://www.bsiag.com 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 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)
 
* 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 [http://www.eclipse.org/forums/index.php?t=thread&frm_id=174 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
 +
[https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&columnlist=bug_id%2Cbug_severity%2Cpriority%2Ctarget_milestone%2Cbug_status%2Cresolution%2Ccomponent%2Cassigned_to%2Cshort_desc&f1=attachments.filename&list_id=3534658&o1=substring&product=Scout&query_format=advanced&v1=patch&order=bug_id&query_based_on= this query]
  
 
= Development IDE Configuration =
 
= Development IDE Configuration =
Line 119: Line 136:
 
= Getting the Scout Sources  =
 
= Getting the Scout Sources  =
  
You may download the Eclipse Scout source code from eclipse.org
+
Scout is now using git see: http://git.eclipse.org/c/scout/
  
   https://dev.eclipse.org/svnroot/technology/org.eclipse.scout/
+
   Runtime: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.rt.git
 +
  SDK: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.sdk.git
  
Alternatively, you may browse the SVN repository [http://dev.eclipse.org/viewcvs/viewvc.cgi/?root=Technology_SCOUT online]
+
{{ScoutLink| Contribution|Scout Git Scripts|Some internal Scout Git scripts}}
 +
 
 +
The sources for Juno incl. service releases are still available on SVN (branch 3.8). For Kepler only git is used.
 +
 
 +
== Kepler ==
 +
Branch: master
 +
 
 +
Runtime: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.rt.git
 +
SDK: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.sdk.git
 +
 
 +
== 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
 +
 
 +
You may browse the SVN repository [http://dev.eclipse.org/viewcvs/viewvc.cgi/?root=Technology_SCOUT online]
 +
 
 +
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 ==
 
== Indigo ==
Line 147: Line 193:
 
   SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/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
  
== Juno ==
 
  
The most current state of the Juno release of Eclipse Scout is
+
= 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.
  
  Eclipse Scout 3.8.x (Juno)
+
== Create links ==
  Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/branches/2012-Jun
+
=== Forum to Wiki ===
  SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/branches/2012-Jun
+
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.
 +
 
 +
{| border="1" |
 +
! '''What you type''' !! '''What you see'''
 +
|-
 +
|
 +
<pre><nowiki>
 +
{{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
 +
}}
 +
</nowiki></pre>
 +
|
 +
{{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 ==
  
To get access to the sources of the Juno milestone you may access the repository through the tags provided below.
+
=== Java Syntax highlighting ===
 +
Tag the code blocks with source tag
 +
{| border="1" |
 +
! '''What you type''' !! '''What you see'''
 +
|-
 +
|
 +
<pre><nowiki>
 +
<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>
 +
</nowiki></pre>
 +
|
 +
<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>
 +
|-
 +
|
 +
<pre><nowiki>
 +
<source lang="xml">
 +
<filter
 +
    aliases="/process"
 +
    class="org.eclipse.scout.http.servletfilter.security.LDAPSecurityFilter"
 +
    ranking="50">
 +
</filter>
 +
</source>
 +
</nowiki></pre>
 +
|
 +
<source lang="xml">
 +
<filter
 +
    aliases="/process"
 +
    class="org.eclipse.scout.http.servletfilter.security.LDAPSecurityFilter"
 +
    ranking="50">
 +
</filter>
 +
</source>
 +
|-
 +
|
 +
<pre><nowiki>
 +
<source lang="sql">
 +
select language_id, name
 +
from languages
 +
</source>
 +
</nowiki></pre>
 +
|
 +
<source lang="sql">
 +
select language_id, name
 +
from languages
 +
</source>
 +
|}
  
  Eclipse Scout 3.8.0 (M5)
 
  Runtime: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.rt/tags/2012-01-31_S-3.8.0M5/
 
  SDK: http://dev.eclipse.org/svnroot/technology/org.eclipse.scout/scout.sdk/tags/2012-01-31_S-3.8.0M5/
 
  
 
= Committer Nominations =
 
= Committer Nominations =
  
 
Nominations for committer status can be created in the committer portal. Nominations should follow the according to the Eclipse  
 
Nominations for committer status can be created in the committer portal. Nominations should follow the according to the Eclipse  
[http://wiki.eclipse.org/Development_Resources/HOWTO/Nominating_and_Electing_a_New_Committer#What_Should_a_Nomination_Look_Like.3F wiki guidlines]
+
[http://wiki.eclipse.org/Development_Resources/HOWTO/Nominating_and_Electing_a_New_Committer#What_Should_a_Nomination_Look_Like.3F wiki guidlines].
 +
A good starting point for nominations is a significant number (8-15) of well written patches, meaningful posts on the [http://www.eclipse.org/forums/index.php?t=thread&frm_id=174 Scout forum] and other community activities.
 +
To count patches we typically use the [http://www.eclipse.org/projects/ip_log.php?projectid=technology.scout Scout IP Log].
 +
 
 +
== Preparing Nominations ==
  
 
== Current Nominations ==
 
== Current Nominations ==
 +
* [[Scout/Scout_Nomination_CSC|Christoph Schwank]], May 2013
 +
* [[Scout/Scout_Nomination_OSC|Oli Schmid]], May 2013
 +
* [[Scout/Scout_Nomination_BKO|Bruno Koeferli]], May 2013
  
 
== Past Nominations ==
 
== Past Nominations ==
 
+
* [[Scout/Scout_Nomination_AMO|Adrian Moser]], Dezember 2012
 +
* [[Scout/Scout_Nomination_BSH|Beat Schwarzentrub]], Dezember 2012
 +
* [[Scout/Scout_Nomination_JBR|Jeremie Bresson]], Dezember 2012
 +
* [[Scout/Scout_Nomination_KLE|Ken Lee]], August 2012
 +
* [[Scout/Scout_Nomination_SME|Stephan Merkli]], August 2012
 
* [[Scout/Scout_Nomination_MVI|Matthias Villiger]], September 2011
 
* [[Scout/Scout_Nomination_MVI|Matthias Villiger]], September 2011
 
* [[Scout/Scout_Nomination_CGU|Claudio Guglielmo]], September 2011
 
* [[Scout/Scout_Nomination_CGU|Claudio Guglielmo]], September 2011
 
= More to come ... =
 

Revision as of 09:54, 1 May 2013

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:

  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 and Version

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 Scout version that you are having the issue with. For the Scout coming with Indigo this would be 3.7.0.

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

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

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

Scout is now using git see: http://git.eclipse.org/c/scout/

 Runtime: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.rt.git
 SDK: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.sdk.git

Some internal Scout Git scripts

The sources for Juno incl. service releases are still available on SVN (branch 3.8). For Kepler only git is used.

Kepler

Branch: master

Runtime: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.rt.git
SDK: git://git.eclipse.org/gitroot/scout/org.eclipse.scout.sdk.git

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

You may browse the SVN repository online

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 
}}
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