Difference between revisions of "SMILA/Project Guidelines"

From Eclipsepedia

Jump to: navigation, search
(2. Handling 3rd-party libraries)
m (4. File Headers)
 
Line 43: Line 43:
 
The file header template:
 
The file header template:
  
  /******************************************************************************
+
  /************************************************************************************
   * Copyright (c) 2008 empolis GmbH and brox IT Solutions GmbH.
+
   * Copyright (c) 2013 Empolis Information Management GmbH and brox IT Solutions GmbH.
 
   * All rights reserved. This program and the accompanying materials
 
   * All rights reserved. This program and the accompanying materials
 
   * are made available under the terms of the Eclipse Public License v1.0
 
   * are made available under the terms of the Eclipse Public License v1.0
Line 52: Line 52:
 
   * Contributors:
 
   * Contributors:
 
   *    Juergen Schumacher (empolis GmbH) - initial creator
 
   *    Juergen Schumacher (empolis GmbH) - initial creator
   ******************************************************************************/
+
   ************************************************************************************/
  
 
Note:
 
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.
 
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.

Latest revision as of 11:02, 24 March 2013

Contents

[edit] Project Guidelines

[edit] 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

[edit] 2. Handling 3rd-party libraries

We have decided to check in all 3rd-party libraries in Subversion (SVN) that we make use of in SMILA. 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 SVN.

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 SMILA in the SVN.

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.

[edit] 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)

[edit] 4. File Headers

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

The file header template:

/************************************************************************************
 * Copyright (c) 2013 Empolis Information Management 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.