Difference between revisions of "SMILA/Project Guidelines"

From Eclipsepedia

Jump to: navigation, search
(3. SVN Comments during Commit.)
m (3. SVN Comments during Commit.)
Line 44: Line 44:
 
=== 3. SVN Comments during Commit. ===
 
=== 3. SVN Comments during Commit. ===
  
When commiting source code you always have to add a comment to the check-in. This check-in must contain a JIRA issue id!
+
When commiting source code you always have to add a comment to the check-in. if the check-in belongs to a Bugzilla issue (bug or enhancement) you should provide the bugzilla issue id!
  
The issue comment should look like:
+
A sample comment could look like this: "Taskmanager task delivery fixed (#1234)" (where '1234' would refer a bugzilla issue)
 
+
# <module/area> | <main change/topic>
+
- <detail comment>
+
ECS-24
+
  
 
=== 4. File Headers ===
 
=== 4. File Headers ===

Revision as of 10:33, 24 March 2013

Contents

Project Guidelines

1. Preparation for Eclipse Legal Process

Here is the list of documents that each of us has to know about and act accordingly to them:

A Guide to the Legal Documentation for Eclipse-Based Content

About File Templates

Generally, we always have to follow The Three Laws of Eclipse.

Here you will find a detailed documentation of the current IP Process. A short version of it could be found under The Eclipse IP Process in Eight Cartoons.

Immediately, after we've entered the incubation phase, we should stick to Guidelines for Using the Parallel IP Process

2. Handling 3rd-party libraries

We have decided to check in all 3rd-party libraries in VCS (Subversion) that we make use of in eccenca/EILF. This does not only apply to binaries but also to the source code. So please check in as well compiled libs (JARs) as their source code in our VCS.

This decision has been made keeping the requirements for OSGi in mind. That means for all 3rd party libraries we need OSGi bundles. These bundles will have the name [package]-[version] and will be stored in eccenca/EILF in the VCS system.

Update:

Since we are going to produce bundles of 3rd-party software, we should finally take care that these bundles are accepted by Eclipse Orbit Project. To be able to achieve this we have to comply to http://wiki.eclipse.org/Adding_Bundles_to_Orbit.


Important:

For each 3rd-party library whose licensing is not clearly compatible to EPL at the moment, an issue in JIRA must be created. There is a special component called "Legal Process" in JIRA that should be used in such issues. By doing so it will be very easy to track those issues and keep an eye on them.


3. SVN Comments during Commit.

When commiting source code you always have to add a comment to the check-in. if the check-in belongs to a Bugzilla issue (bug or enhancement) you should provide the bugzilla issue id!

A sample comment could look like this: "Taskmanager task delivery fixed (#1234)" (where '1234' would refer a bugzilla issue)

4. File Headers

Both managements agreed that the we should have only one common file header.

The file header template:

/******************************************************************************
 * Copyright (c) 2008 empolis GmbH and brox IT Solutions GmbH.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Juergen Schumacher (empolis GmbH) - initial creator
 ******************************************************************************/

Note: The initial developer(s) must be pointed out in "Contributors:" section. All other developers, that subsequently provide some small changes on the particular file, are not obliged to list their names too.