blob: b1769eb3db77c2fbff45450d7322e8de0876ca41 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="keywords" content="SMILA/Project Guidelines" />
<link rel="shortcut icon" href="http://wiki.eclipse.org/SMILA/favicon.ico" />
<link rel="search" type="application/opensearchdescription+xml" href="http://wiki.eclipse.org/opensearch_desc.php" title="Eclipsepedia (English)" />
<link rel="alternate" type="application/rss+xml" title="Eclipsepedia RSS Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&amp;feed=rss" />
<link rel="alternate" type="application/atom+xml" title="Eclipsepedia Atom Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&amp;feed=atom" />
<title>SMILA/Project Guidelines - Eclipsepedia</title>
<style type="text/css" media="screen,projection">/*<![CDATA[*/ @import "/skins/eclipsenova/novaWide.css?116"; /*]]>*/</style>
<link rel="stylesheet" type="text/css" media="print" href="http://wiki.eclipse.org/skins/eclipsenova/eclipsenovaPrint.css?116" />
<link rel="stylesheet" type="text/css" media="handheld" href="http://wiki.eclipse.org/skins/eclipsenova/handheld.css?116" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/header.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/tabs.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/visual.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/layout.css" media="screen" />
<link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/footer.css" media="screen" />
<!--[if IE]><link rel="stylesheet" type="text/css" href="/skins/eclipsenova/IEpngfix.css" media="screen" /><![endif]-->
<!--[if lt IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE50Fixes.css?116";</style> <![endif]-->
<!--[if IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE55Fixes.css?116";</style><![endif]-->
<!--[if IE 6]><style type="text/css">@import "/skins/eclipsenova/IE60Fixes.css?116";</style><![endif]-->
<!--[if IE 7]><style type="text/css">@import "/skins/eclipsenova/IE70Fixes.css?116";</style><![endif]-->
<!--[if lt IE 7]><script type="text/javascript" src="/skins/common/IEFixes.js?116"></script>
<meta http-equiv="imagetoolbar" content="no" /><![endif]-->
<script type= "text/javascript">/*<![CDATA[*/
var skin = "eclipsenova";
var stylepath = "/skins";
var wgArticlePath = "/$1";
var wgScriptPath = "";
var wgScript = "/index.php";
var wgServer = "http://wiki.eclipse.org";
var wgCanonicalNamespace = "";
var wgCanonicalSpecialPageName = false;
var wgNamespaceNumber = 0;
var wgPageName = "SMILA/Project_Guidelines";
var wgTitle = "SMILA/Project Guidelines";
var wgAction = "view";
var wgRestrictionEdit = [];
var wgRestrictionMove = [];
var wgArticleId = "15478";
var wgIsArticle = true;
var wgUserName = null;
var wgUserGroups = null;
var wgUserLanguage = "en";
var wgContentLanguage = "en";
var wgBreakFrames = false;
var wgCurRevisionId = "119887";
var wgVersion = "1.12.0";
var wgEnableAPI = true;
var wgEnableWriteAPI = false;
/*]]>*/</script>
<script type="text/javascript" src="http://wiki.eclipse.org/skins/common/wikibits.js?116"><!-- wikibits js --></script>
<!-- Performance mods similar to those for bug 166401 -->
<script type="text/javascript" src="http://wiki.eclipse.org/index.php?title=-&amp;action=raw&amp;gen=js&amp;useskin=eclipsenova"><!-- site js --></script>
<!-- Head Scripts -->
<script type="text/javascript" src="http://wiki.eclipse.org/skins/common/ajax.js?116"></script>
<link rel="stylesheet" type="text/css" href="Project_Guidelines.html" /> </head>
<body class="mediawiki ns-0 ltr page-SMILA_Project_Guidelines">
<div id="globalWrapper">
<div id="column-one">
<!-- Eclipse Additions for the Top Nav start here M. Ward-->
<div id="header">
<div id="header-graphic">
<img src="http://wiki.eclipse.org/skins/eclipsenova/eclipse.png" alt="Eclipse Wiki">
</div>
<!-- Pulled 101409 Mward -->
<div class="portlet" id="p-personal">
<div class="pBody">
<ul>
<li id="pt-login"><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&amp;returnto=SMILA/Project_Guidelines">Log in</a></li>
</ul>
</div>
</div>
<div id="header-icons">
<div id="sites">
<ul id="sitesUL">
<li><a href="http://www.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/eclipseIcon.png" width="28" height="28" alt="Eclipse Foundation" title="Eclipse Foundation" /><div>Eclipse Foundation</div></a></li>
<li><a href="http://marketplace.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/marketplace.png" width="28" height="28" alt="Eclipse Marketplace" title="Eclipse Marketplace" /><div>Eclipse Marketplace</div></a></li>
<li><a href="https://bugs.eclipse.org/bugs"><img src="http://dev.eclipse.org/custom_icons/system-search-bw.png" width="28" height="28" alt="Bugzilla" title="Bugzilla" /><div>Bugzilla</div></a></li>
<li><a href="http://live.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/audio-input-microphone-bw.png" width="28" height="28" alt="Live" title="Live" /><div>Eclipse Live</div></a></li>
<li><a href="http://planeteclipse.org"><img src="http://dev.eclipse.org/large_icons/devices/audio-card.png" width="28" height="28" alt="PlanetEclipse" title="Planet" /><div>Planet Eclipse</div></a></li>
<li><a href="http://portal.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/preferences-system-network-proxy-bw.png" width="28" height="28" alt="Portal" title="Portal" /><div>My Foundation Portal</div></a></li>
</ul>
</div>
</div>
</div>
<!-- NEW HEADER STUFF HERE -->
<div id="header-menu">
<div id="header-nav">
<ul> <li><a class="first_one" href="http://wiki.eclipse.org/" target="_self">Home</a></li> <li><a href="http://www.eclipse.org/downloads/" target="_self">Downloads</a></li>
<li><a href="http://www.eclipse.org/users/" target="_self">Users</a></li>
<li><a href="http://www.eclipse.org/membership/" target="_self">Members</a></li>
<li><a href="http://wiki.eclipse.org/index.php/Development_Resources" target="_self">Committers</a></li>
<li><a href="http://www.eclipse.org/resources/" target="_self">Resources</a></li>
<li><a href="http://www.eclipse.org/projects/" target="_self">Projects</a></li>
<li><a href="http://www.eclipse.org/org/" target="_self">About Us</a></li>
</ul>
</div>
<div id="header-utils">
<!-- moved the search window here -->
<form action="http://wiki.eclipse.org/Special:Search" >
<input class="input" name="search" type="text" accesskey="f" value="" />
<input type='submit' onclick="this.submit();" name="go" id="searchGoButton" class="button" title="Go to a page with this exact name if one exists" value="Go" />&nbsp;
<input type='submit' onclick="this.submit();" name="fulltext" class="button" id="mw-searchButton" title="Search Eclipsepedia for this text" value="Search" />
</form>
</div>
</div>
<!-- Eclipse Additions for the Header stop here -->
<!-- Additions and mods for leftside nav Start here -->
<!--Started nav rip here-->
<!-- these are the nav controls main page, changes etc -->
<div id="novaContent" class="faux">
<div id="leftcol">
<ul id="leftnav">
<!-- these are the page controls, edit history etc -->
<li class="separator"><a class="separator">Navigation &#160;&#160;</li>
<li id="n-mainpage"><a href="http://wiki.eclipse.org/Main_Page">Main Page</a></li>
<li id="n-portal"><a href="http://wiki.eclipse.org/Eclipsepedia:Community_Portal">Community portal</a></li>
<li id="n-currentevents"><a href="http://wiki.eclipse.org/Eclipsepedia:Current_events">Current events</a></li>
<li id="n-recentchanges"><a href="http://wiki.eclipse.org/Special:Recentchanges">Recent changes</a></li>
<li id="n-randompage"><a href="http://wiki.eclipse.org/Special:Random">Random page</a></li>
<li id="n-help"><a href="http://wiki.eclipse.org/Help:Contents">Help</a></li>
<li class="separator"><a class="separator">Toolbox &#160;&#160;</a></li>
<li id="t-whatlinkshere"><a href="http://wiki.eclipse.org/Special:Whatlinkshere/SMILA/Project_Guidelines">What links here</a></li>
<li id="t-recentchangeslinked"><a href="http://wiki.eclipse.org/Special:Recentchangeslinked/SMILA/Project_Guidelines">Related changes</a></li>
<!-- This is the toolbox section -->
<li id="t-upload"><a href="http://wiki.eclipse.org/Special:Upload">Upload file</a></li>
<li id="t-specialpages"><a href="http://wiki.eclipse.org/Special:Specialpages">Special pages</a></li>
<li id="t-print"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Guidelines&amp;printable=yes">Printable version</a></li> <li id="t-permalink"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Guidelines&amp;oldid=119887">Permanent link</a></li> </ul>
</div>
<!-- Additions and mods for leftside nav End here -->
<div id="column-content">
<div id="content">
<a name="top" id="top"></a>
<div id="tabs">
<ul class="primary">
<li class="active"><a href="Project_Guidelines.html"><span class="tab">Page</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=Talk:SMILA/Project_Guidelines&amp;action=edit"><span class="tab">Discussion</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Guidelines&amp;action=edit"><span class="tab">View source</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Project_Guidelines&amp;action=history"><span class="tab">History</span></a></li>
<li><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&amp;returnto=SMILA/Project%20Guidelines"><span class="tab">Edit</span></a></li>
</ul>
</div>
<script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script>
<h1 class="firstHeading">SMILA/Project Guidelines</h1>
<div id="bodyContent">
<h3 id="siteSub">From Eclipsepedia</h3>
<div id="contentSub"><span class="subpages">&lt; <a href="../SMILA.html" title="SMILA">SMILA</a></span></div>
<div id="jump-to-nav">Jump to: <a href="Project_Guidelines.html#column-one">navigation</a>, <a href="Project_Guidelines.html#searchInput">search</a></div> <!-- start content -->
<table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Contents</h2></div>
<ul>
<li class="toclevel-1"><a href="Project_Guidelines.html#Project_Guidelines"><span class="tocnumber">1</span> <span class="toctext">Project Guidelines</span></a>
<ul>
<li class="toclevel-2"><a href="Project_Guidelines.html#1._Preparation_for_Eclipse_Legal_Process"><span class="tocnumber">1.1</span> <span class="toctext">1. Preparation for Eclipse Legal Process</span></a></li>
<li class="toclevel-2"><a href="Project_Guidelines.html#2._Handling_3rd-party_libraries"><span class="tocnumber">1.2</span> <span class="toctext">2. Handling 3rd-party libraries</span></a></li>
<li class="toclevel-2"><a href="Project_Guidelines.html#3._SVN_Comments_during_Commit."><span class="tocnumber">1.3</span> <span class="toctext">3. SVN Comments during Commit.</span></a></li>
<li class="toclevel-2"><a href="Project_Guidelines.html#4._File_Headers"><span class="tocnumber">1.4</span> <span class="toctext">4. File Headers</span></a></li>
</ul>
</li>
</ul>
</td></tr></table><script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script>
<a name="Project_Guidelines"></a><h2> <span class="mw-headline"> Project Guidelines </span></h2>
<a name="1._Preparation_for_Eclipse_Legal_Process"></a><h3> <span class="mw-headline"> 1. Preparation for Eclipse Legal Process </span></h3>
<p>Here is the list of documents that each of us has to know about and act accordingly to them:
</p><p><a href="http://www.eclipse.org/legal/guidetolegaldoc.php" class="external text" title="http://www.eclipse.org/legal/guidetolegaldoc.php" rel="nofollow">A Guide to the Legal Documentation for Eclipse-Based Content</a>
</p><p><a href="http://www.eclipse.org/legal/epl/about.php" class="external text" title="http://www.eclipse.org/legal/epl/about.php" rel="nofollow">About File Templates</a>
</p><p>Generally, we always have to follow <a href="http://www.eclipse.org/projects/dev_process/three-laws-of-eclipse.php" class="external text" title="http://www.eclipse.org/projects/dev_process/three-laws-of-eclipse.php" rel="nofollow">The Three Laws of Eclipse</a>.
</p><p>Here you will find a detailed documentation of the current <a href="http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf" class="external text" title="http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf" rel="nofollow">IP Process</a>.
A short version of it could be found under <a href="http://www.eclipse.org/projects/dev_process/ip-process-in-cartoons.php" class="external text" title="http://www.eclipse.org/projects/dev_process/ip-process-in-cartoons.php" rel="nofollow">The Eclipse IP Process in Eight Cartoons</a>.
</p><p>Immediately, after we've entered the incubation phase, we should stick to <a href="http://www.eclipse.org/projects/dev_process/parallel-ip-process.php" class="external text" title="http://www.eclipse.org/projects/dev_process/parallel-ip-process.php" rel="nofollow">Guidelines for Using the Parallel IP Process</a>
</p>
<a name="2._Handling_3rd-party_libraries"></a><h3> <span class="mw-headline"> 2. Handling 3rd-party libraries </span></h3>
<p>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.
</p><p>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 <b>[package]-[version]</b> and will be stored in eccenca/EILF in the VCS system.
</p>
<table width="100%" style="background-color:#ffffce; padding-left:30px;">
<tr>
<td>
<p><b>Update:</b>
</p><p>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 <a href="http://wiki.eclipse.org/Adding_Bundles_to_Orbit" class="external free" title="http://wiki.eclipse.org/Adding_Bundles_to_Orbit" rel="nofollow">http://wiki.eclipse.org/Adding_Bundles_to_Orbit</a>.
</p>
</td></tr></table>
<p><br />
</p>
<table width="100%" style="background-color:#ffcccc; padding-left:30px;">
<tr>
<td>
<p><b>Important:</b>
</p><p>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.
</p>
</td></tr></table>
<p><br />
</p>
<a name="3._SVN_Comments_during_Commit."></a><h3> <span class="mw-headline"> 3. SVN Comments during Commit. </span></h3>
<p>When commiting source code you always have to add a comment to the check-in. This check-in must contain a JIRA issue id!
</p><p>The issue comment should look like:
</p>
<pre># &lt;module/area&gt; | &lt;main change/topic&gt;
- &lt;detail comment&gt;
ECS-24
</pre>
<a name="4._File_Headers"></a><h3> <span class="mw-headline"> 4. File Headers </span></h3>
<p>Both managements agreed that the we should have only one common file header.
</p><p>The file header template:
</p>
<pre>/******************************************************************************
* 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
******************************************************************************/
</pre>
<p>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.
</p>
<!--
NewPP limit report
Preprocessor node count: 12/1000000
Post-expand include size: 0/2097152 bytes
Template argument size: 0/2097152 bytes
#ifexist count: 0/100
-->
<!-- Saved in parser cache with key wikidb:pcache:idhash:15478-0!1!0!!en!2!edit=0 and timestamp 20110617075120 -->
<div class="printfooter">
Retrieved from "<a href="Project_Guidelines.html">http://wiki.eclipse.org/SMILA/Project_Guidelines</a>"</div>
<!-- end content -->
<div class="visualClear"></div>
</div>
</div>
</div>
<!-- Yoink of toolbox for phoenix moved up -->
</div>
</div>
<div id="clearFooter"/>
<div id="footer" >
<ul id="footernav">
<li class="first"><a href="http://www.eclipse.org/">Home</a></li>
<li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li>
<li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li>
<li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li>
<li><a href="http://www.eclipse.org/org/foundation/contact.php">Contact</a></li>
<li><a href="http://wiki.eclipse.org/Eclipsepedia:About" title="Eclipsepedia:About">About Eclipsepedia</a></li>
</ul>
<span id="copyright">Copyright &copy; 2011 The Eclipse Foundation. All Rights Reserved</span>
<p id="footercredit">This page was last modified 12:13, 23 September 2008 by <a href="http://wiki.eclipse.org/User:T.menzel.brox.de" title="User:T.menzel.brox.de">thomas menzel</a>. Based on work by <a href="http://wiki.eclipse.org/index.php?title=User:Dhazin.gmail.com&amp;action=edit" class="new" title="User:Dhazin.gmail.com">Dmitry Hazin</a>.</p>
<p id="footerviews">This page has been accessed 1,488 times.</p>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-910670-4");
pageTracker._trackPageview();
</script>
<!-- <div class="visualClear"></div> -->
<script type="text/javascript">if (window.runOnloadHook) runOnloadHook();</script>
</div>
<!-- Served in 0.080 secs. --></body></html>