dev_process/project-log.php

<?php  																														require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/app.class.php");	require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/nav.class.php"); 	require_once($_SERVER['DOCUMENT_ROOT'] . "/eclipse.org-common/system/menu.class.php"); 	$App 	= new App();	$Nav	= new Nav();	$Menu 	= new Menu();		include($App->getProjectCommon());    # All on the same line to unclutter the user's desktop'

$pageTitle 		= "Project Log";
$pageKeywords	= "development process";
$pageAuthor		= "Bjorn Freeman-Benson Nov 20/05";

ob_start();
?>
    <div id="maincontent">
	<div id="midcolumn">
		
<h1>Project Log</h1>
<p><i>version 026 - October 14, 2005</i></p>
<p><a href="index.php">[This is one page of the larger document.]</a></p>
<h2>Project Log</h2>

<p align="left">The <a href="/org/documents/Eclipse%20IP%20Policy2003_12_03%20Final.pdf"> Eclipse IP Policy</a> requires
    <a href="/legal/committerguidelines.php"> certain due
    diligence and record keeping</a>.
    Small contributions in the form of bugzilla patches and the like can be
    committed directly to the code base (after the appropriate contributor
    information is recorded). Medium, large, and all third-party (non-EPL
    licensed) contributions require the <a href="/legal/ContributionQuestionnairePart1-v1.0.htm"> Code Contribution
    Questionnaire</a> and
    additional record keeping. Maintaining a current and accurate Project Log is
    the best way to keep this information up-to-date.

<p>The Project Log is a CSV file (a spreadsheet saved in the open Comma
Separated Value file format) containing the following sections. The Project Log
must be available via a public url on the project's website, and a static copy
must be included in the <a href="release-review.php">Release Review</a>
materials for each release.</p>

<h4>Section 1 (Committers)</h4>
<p>A list of all the Committers, past and present, whose contribution is still
active in the repository. A Committer whose code has been entirely removed from
the active branches does not need to be listed. The columns for this section
are:</p>
<ul>
  <li>dev.eclipse.org unix login name</li>
</ul>

<h4>Section 2 (Developers)</h4>

<p>A list of all the non-Committers whose contribution is still active in the
repository. The columns for this section are:</p>
<ul>
  <li>component (CVS directory)</li>
  <li>bug #</li>
  <li>contributor's name (see Additional Information below)</li>
  <li>contribution size (LOC or &quot;small&quot; where small is defined as
    &quot;less than 100 LOC&quot;)</li>
  <li>committer who committed this contribution</li>
  <li>description if there is no bug# or if there are multiple bug #s</li>
</ul>
<p>Note that it behooves the project to use the full capabilities of Bugzilla to
assist with generating this report. If the project uses the following features,
then simple queries will generate most of section 2:</p>
<ol>
  <li>All code changes (100% of them) refer to a Bugzilla entry</li>
  <li>All commit messages include the corresponding bug numbers.</li>
  <li>VERIFY and CLOSE all RESOLVED bugs when closing out a release.</li>
  <li>Target milestones for &quot;fixed in version&quot;</li>
</ol>
<h4>Section 3 (Third Party Software)</h4>
<p>A list of the non-Eclipse third party software included in the project. The
columns for this section are:</p>
<ul>
  <li>name including version</li>
  <li>directory location or jar file</li>
  <li>license name and version (including any licenses related to embedded third
    party software)</li>
  <li>usage (e.g. modified/unmodified, source, object, derivative work, entire
    package or which subset)</li>
</ul>
<h3>Additional Information</h3>
<p align="left">The Foundation needs to maintain contact information for all
contributors however the Foundation also needs to abide by its <a href="/legal/privacy.php">Privacy
Policy</a>. The projects handles these two requirements by maintaining an internal, non-public,
database (list) of contact information for all project Contributors. Committers
are stored by in the Foundation database under their dev.eclipse.org unix login name, thus the only
requirement for section 1 is that login name.&nbsp; Contributors are stored by
the Projects in private, in a text file, a spreadsheet, an HTML table, a small
database, or whatever the project chooses. Section 2 uses the contributor names
as keys into that information to avoid having to list the
contributor's email address or mailing address in the Project IP log. The
Project sends the contact information to the Foundation as part of the process
of a <a href="release-review.php">Release Review</a>.</p>
<p align="left">All of this is a long way of saying that the project leadership
and/or PMC must keep track of the contributors' contact information in private
and send that private list to the EMO at the Release Review.<sup>1</sup></p>
<h3>Applicability</h3>
<p>The project log keeps track of code contributions but also, as per the <a href="/org/documents/Eclipse%20IP%20Policy2003_12_03%20Final.pdf"> Eclipse IP Policy</a>,
documentation and other non-code contributions.</p>

<p><sup>1</sup> For a while, there was a concept of &quot;contributor Foundation
database key&quot;; we have moved away from that and are no longer using that
process.</p>
</div>
</div>
<?php
	# Paste your HTML content between the EOHTML markers!	
	$html = ob_get_contents();
	ob_end_clean();

	# Generate the web page
	$App->generatePage($theme, $Menu, $Nav, $pageAuthor, $pageKeywords, $pageTitle, $html);
?>