blob: 884b6e1e144364d112799c04d9b83166138ea48d [file] [log] [blame]
<h1>Project_Name Version Release Review</h1>
<h2>Features</h2>
<!--
Summarize the major features of this release as well as any other features that have
generated significant discussion amongst the community during the development cycle.
Compare the features against the Roadmap to understand the project's conformance or divergence.
The community will use this release and the ecosystem will build products on top of this release,
and both need to know what features were included or excluded.-->
<p>We did some really good stuff on this project.</p>
<a name="Non-Code_Aspects"></a><h2>Non-Code Aspects</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the state of the non-code aspects of the release including: user documentation, localization/externalization, examples, tutorials, articles, and so on. Have the existing artifacts been updated? Are there new artifacts? Have the obsolete ones been retired or at least marked as pertaining only to older material?
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> The non-code aspects are essential for the wide-spread adoption of the release. (Reference <a href="http://www.eclipse.org/projects/dev_proceess/development_process.php#2_4_Eclipse_Ecosystem" class="external autonumber" title="http://www.eclipse.org/projects/dev_proceess/development_process.php#2_4_Eclipse_Ecosystem" rel="nofollow">[2]</a>)
</p>
<a name="APIs"></a><h2>APIs</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Certify that the APIs in this release are <i><a href="http://www.eclipse.org/projects/dev_process/eclipse-quality.php" class="external text" title="http://www.eclipse.org/projects/dev_process/eclipse-quality.php" rel="nofollow">Eclipse Quality</a></i>. <span style="background-color: rgb(255, 255, 204);">The project lead will personally certify that the requirements for quality have been met and/or discuss any deficiences</span>.
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> Eclipse members build commercial tools on top of the extensible frameworks and thus the quality of the APIs is extremely important. (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_2_Quality_Culture" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_2_Quality_Culture" rel="nofollow">[3]</a>)
</p>
<a name="Architectural_Issues"></a><h2>Architectural Issues</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the architectural quality of the release. Discuss the <i>intrinsic nature of being extensible</i> embodied by this project. Discuss issues such as unresolved overlap with other projects, unpaid "merge debt" from incorporating various components, and so on.
</p><p><i>Reason: </i>Eclipse members build commercial tools on top of the extensible frameworks and thus the quality of the architecture is important. (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_2_Quality_Culture" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_2_Quality_Culture" rel="nofollow">[4]</a>)
</p>
<a name="Tool_Usability"></a><h2>Tool Usability</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the usability of the tools. Usability in this sense is about using the tools to solve development problems, not the more academic sense of UI evaluation/testing.
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> Without usable tools, the project will not attract the user community necessary to enable the ecosystem.&nbsp; (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_5_Three_Communities" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_5_Three_Communities" rel="nofollow">[5]</a>)
</p>
<a name="End-of-Life"></a><h2>End-of-Life</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the features (APIs and any significant user features) from previous releases that are being end-of-life'd in this release. End of life includes both deprecation and actual removal.
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> The community builds products that rely on features and so they need to know when these features are changing. (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_5_Three_Communities" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_5_Three_Communities" rel="nofollow">[6]</a>)
</p>
<a name="Bugzilla"></a><h2>Bugzilla</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the bugzilla situation. How many bug records (defects and enhancements) have been opened/closed/deferred/new, etc? How many P1, P2, ..., bug records are outstanding?
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> Summaries of the bugzilla records offer a glimpse into the project productivity. They also offer an estimate of the outstanding risk. And the summary is used to alert the community to known issues. (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_4_Eclipse_Ecosystem" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_4_Eclipse_Ecosystem" rel="nofollow">[7]</a>)
</p>
<a name="Standards"></a><h2>Standards</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the standards compliance of this release. If the features are based on defined, pending, or ad-hoc standards, what is the state of those standards and what is the state of the support for those standards in this release.
</p><p><i><b><font color="#0080c0">Reason: </font></b></i>Eclipse is about building frameworks and tools based on standards, so we need to make sure that we are conforming to the appropriate standards. (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_4_Eclipse_Ecosystem" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_4_Eclipse_Ecosystem" rel="nofollow">[8]</a>)
</p>
<a name="UI_Usability"></a><h2>UI Usability</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the user interface usability and the conformance to the <a href="/User_Interface_Guidelines" title="User Interface Guidelines">User_Interface_Guidelines</a>. Include section 508 compliance, language pack conformance (does the code support multiple languages), etc. Explain any deviations from the user interface guidelines and standards.
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> The user community is larger than just mouse-wielding, English-speaking, computer jockeys. We need to support that larger community. (References <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_2_Quality_Culture" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_2_Quality_Culture" rel="nofollow">[9]</a>,<a href="/User_Interface_Guidelines" title="User Interface Guidelines">User_Interface_Guidelines</a>)
</p>
<a name="Schedule"></a><h2>Schedule</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Discuss the initial schedule and any changes to the schedule over the course of the release, i.e., what the project team achieved. Discuss whether milestones were met or slipped.
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> The community relies on consistent schedules from Eclipse so that projects and products can plan for the correct dependencies. (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_3_Collective_Reputation" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_3_Collective_Reputation" rel="nofollow">[10]</a>)
</p>
<a name="Communities"></a><h2>Communities</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Summarize the project's development of its three communities. Consider the interactions on bugzilla, the mailing lists, the newsgroups, public conference calls, blogs, PR activities, code camps, conference tutorials, coordinating with other Eclipse projects and other open source projects (Apache, ObjectWeb, etc), ...
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> It is important for Eclipse projects to build a community around the project, not just deliver code for a project. This review item is about the success of building a community. (Reference <a href="http://www.eclipse.org/projects/dev_process/development_process.php#2_5_Three_Communities" class="external autonumber" title="http://www.eclipse.org/projects/dev_process/development_process.php#2_5_Three_Communities" rel="nofollow">[11]</a>)
</p>
<a name="IP_Issues"></a><h2>IP Issues</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> As per the <a href="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" class="external text" title="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" rel="nofollow">Eclipse IP Policy</a>, these steps must be done:
</p>
<ol><li> The project leadership verifies that:
<ul><li> ... that the about files and use licenses are in place as per the <a href="http://www.eclipse.org/legal/guidetolegaldoc.php" class="external text" title="http://www.eclipse.org/legal/guidetolegaldoc.php" rel="nofollow">Guidelines to Legal Documentation</a>
</li><li> ... all contributions (code, documentation, images, etc) has been committed by individuals who are either Members of the Foundation, or have signed the appropriate Committer Agreement. In either case, these are individuals who have signed, and are abiding by, the Eclipse IP Policy.
</li><li> ... that all significant contributions have been reviewed by the Foundation's legal staff. Include references to the IPZilla numbers of all clearances.
</li><li> ... that all non-Committer code contributions, including third-party libraries, have been documented in the release and reviewed by the Foundation's legal staff. Include references to the IPZilla numbers of all clearances.
</li><li> ... that all Contribution Questionnaires have been completed
</li><li> ... the "copyright" field of each feature is set to the copyright owner (the Eclipse Foundation is <em>rarely</em> the copyright owner).
</li><li> ... that any third-party logos or trademarks included in the distribution (icons, help file logos, etc) have been licensed under the EPL.
</li><li> ... that any fonts or similar third-party images included in the distribution (e.g. in PDF or EPS files) have been licensed under the EPL.
</li></ul>
</li><li> The PMC provides a <a href="http://www.eclipse.org/projects/dev_process/project-log.php" class="external text" title="http://www.eclipse.org/projects/dev_process/project-log.php" rel="nofollow">Project Log</a> that enumerates:
<ol><li> every piece of third party software including information on the license
</li><li> every major contribution
</li><li> the name of every contributor including non-committer contributions via bug fixes with bug #'s
</li><li> the About files which contain any non-standard terms (e.g., a reference to a license other than the EPL, etc)
</li></ol>
</li><li> The EMO will validate for (a) and (b) that Contribution Questionnaires have been properly submitted and EMO approvals have been completed.
</li><li> A frozen copy of the reviewed-and-approved-by-Eclipse-legal Project Log is part of the Release Review documentation. It can be included in the docuware or as a separate document. (Reference <a href="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" class="external autonumber" title="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" rel="nofollow">[12]</a>)
</li></ol>
<p>The provider name for contributed features/bundles should always start with "Eclipse ..." followed by project name. It is up to each PMC to decide how best to describe their project in a meaningful, balanced fashion (either as one top level one or as multiple pieces). Avoid special symbols (e.g. ':' or "-") unless they are part of the project name. Avoid acronyms (unless in common use in software industry, such as XML, or PHP). Capitalization should follow "headline-sytyle capitalization": The only words that are not capitalized are articles (except as the first word), coordinating conjunctions (for example, and, but, and or), prepositions (except as the first or last word), and the to in an infinitive.) For discussion, see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=252813" class="external text" title="https://bugs.eclipse.org/bugs/show_bug.cgi?id=252813" rel="nofollow">Bug 252813</a>.
</p>
<a name="IP_Issues_Speak-Up-Now"></a><h2>IP Issues Speak-Up-Now</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> The EMO explicitly asks during the Release Review if any Member would like to assert that this release infringes their IP rights. If so, the EMO and the project will follow the Eclipse IP Policy in discussions with that Member.
</p><p><i><b><font color="#0080c0">Reason:</font></b></i> One of the important benefits that the Eclipse Foundation provides for its members is the consistent application of the <a href="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" class="external text" title="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" rel="nofollow">Eclipse IP Policy</a> which helps ensure (but does not guarantee) that the framework and tools are useable in commercial products.
</p><p>(Reference <a href="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" class="external autonumber" title="http://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf" rel="nofollow">[13]</a>)
</p>
<a name="Project_Plan"></a><h2>Project Plan</h2>
<p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(255, 153, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">R</span> Per Board resolution of December 11, 2008, to pass a Continuation Review, Graduation Review or Release Review a project must have a current project plan, in the format specified by the EMO, available to the community.
</p><p><span style="border: 1px solid rgb(68, 68, 68); background: rgb(0, 204, 153) none repeat scroll 0% 0%; margin-right: 6px; margin-top: 5px; float: left; color: ivory; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous; font-size: 30px; line-height: 25px; padding-top: 2px; padding-left: 2px; padding-right: 2px; font-family: times;">G</span>If there is a Project Plan (full or even a draft) for the next release, the final issue to cover in the Release Review is the unveiling of the new plan.
</p>