boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2025-03-19 12:30:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Big admonition at top about following the submission process.

Browse Source 
[SVN r37986]
This commit is contained in:
Dave Abrahams 2007-06-13 21:30:36 +00:00
parent e29ee19738
commit 2b0fd4cf25
1 changed files with 257 additions and 225 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

208
formal_review_process.htm
View File

@ -10,6 +10,29 @@
<meta name="ProgId" content="FrontPage.Editor.Document"> <meta name="ProgId" content="FrontPage.Editor.Document">
<title>Boost Formal Review Process</title> <title>Boost Formal Review Process</title>
<style type="text/css">
@import ../boost.css
.first {
margin-top: 0 }
.last {
margin-bottom: 0 }
div.attention, div.caution, div.danger, div.error, div.hint,
div.important, div.note, div.tip, div.warning, div.admonition {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
color: red ;
font-weight: bold ;
font-family: sans-serif }
div.hint p.admonition-title, div.important p.admonition-title,
div.note p.admonition-title, div.tip p.admonition-title,
div.admonition p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
</style>
</head> </head>
<body bgcolor="#FFFFFF" text="#000000"> <body bgcolor="#FFFFFF" text="#000000">
@ -36,6 +59,13 @@
</table> </table>
<h1>Boost Formal Review Process</h1> <h1>Boost Formal Review Process</h1>
<div class="admonition-note admonition">
<p class="first admonition-title">Before Requesting a Formal Review</p>
<p class="last"><b>Read and follow the Boost <a href=
"submission_process.htm">submission process</a>.</b>&nbsp; There are at
least four steps a library author must take before a formal review is
requested.</p>
</div>
<p><a href="#Introduction">Introduction</a><br> <p><a href="#Introduction">Introduction</a><br>
<a href="#Comments">What to include in Review Comments</a><br> <a href="#Comments">What to include in Review Comments</a><br>
@ -45,15 +75,15 @@
<a href="#Wizard">Review Wizard</a><br> <a href="#Wizard">Review Wizard</a><br>
<a href="#Fast-Track">Fast Track Reviews</a></p> <a href="#Fast-Track">Fast Track Reviews</a></p>
<h2><a name="Introduction">Introduction</a></h2> <h2><a name="Introduction" id="Introduction">Introduction</a></h2>
<p>Proposed libraries are accepted into Boost only after undergoing a <p>Proposed libraries are accepted into Boost only after undergoing a
formal review, where Boost mailing list members comment on their formal review, where Boost mailing list members comment on their evaluation
evaluation of the library.</p> of the library.</p>
<p>The final "accept" or "reject" decision is made by the <a href= <p>The final "accept" or "reject" decision is made by the <a href=
"#Review_Manager">Review Manager</a>, based on the review comments "#Review_Manager">Review Manager</a>, based on the review comments received
received from boost mailing list members.</p> from boost mailing list members.</p>
<p>Boost mailing list members are encouraged to submit Formal Review <p>Boost mailing list members are encouraged to submit Formal Review
comments:</p> comments:</p>
@ -67,61 +97,55 @@
</blockquote> </blockquote>
<p>Private comments to a library submitter may be helpful to her or him, <p>Private comments to a library submitter may be helpful to her or him,
but won't help the Review Manager reach a decision, so the other forms but won't help the Review Manager reach a decision, so the other forms are
are preferred.</p> preferred.</p>
<h2>What to include in Review <a name="Comments">Comments</a></h2> <h2>What to include in Review <a name="Comments" id=
"Comments">Comments</a></h2>
<p>Your comments may be brief or lengthy, but basically the Review <p>Your comments may be brief or lengthy, but basically the Review Manager
Manager needs your evaluation of the library.&nbsp; If you identify needs your evaluation of the library.&nbsp; If you identify problems along
problems along the way, please note if they are minor, serious, or the way, please note if they are minor, serious, or showstoppers.</p>
showstoppers.</p>
<p>Here are some questions you might want to answer in your review:</p> <p>Here are some questions you might want to answer in your review:</p>
<ul> <ul>
<li>What is your evaluation of the design?<br> <li>What is your evaluation of the design?<br></li>
</li>
<li>What is your evaluation of the implementation?<br> <li>What is your evaluation of the implementation?<br></li>
</li>
<li>What is your evaluation of the documentation?<br> <li>What is your evaluation of the documentation?<br></li>
</li>
<li>What is your evaluation of the potential usefulness of the <li>What is your evaluation of the potential usefulness of the
library?<br> library?<br></li>
</li>
<li>Did you try to use the library?&nbsp; With what compiler?&nbsp; Did <li>Did you try to use the library?&nbsp; With what compiler?&nbsp; Did
you have any problems?<br> you have any problems?<br></li>
</li>
<li>How much effort did you put into your evaluation? A glance? A quick <li>How much effort did you put into your evaluation? A glance? A quick
reading? In-depth study?<br> reading? In-depth study?<br></li>
</li>
<li>Are you knowledgeable about the problem domain?</li> <li>Are you knowledgeable about the problem domain?</li>
</ul> </ul>
<p>And finally, every review should answer this question:<br> <p>And finally, every review should answer this question:<br></p>
</p>
<ul> <ul>
<li>Do you think the library should be accepted as a Boost <li>Do you think the library should be accepted as a Boost library?&nbsp;
library?&nbsp; Be sure to say this explicitly so that your other Be sure to say this explicitly so that your other comments don't obscure
comments don't obscure your overall opinion.</li> your overall opinion.</li>
</ul> </ul>
<h2><a name="Results">Results</a></h2> <h2><a name="Results" id="Results">Results</a></h2>
<p>At the conclusion of the comment period, the Review Manager will post <p>At the conclusion of the comment period, the Review Manager will post a
a message to the mailing list saying if the library has been accepted or message to the mailing list saying if the library has been accepted or
rejected.&nbsp; A rationale is also helpful, but its extent is up to the rejected.&nbsp; A rationale is also helpful, but its extent is up to the
Review Manager. If there are suggestions, or conditions that must be met Review Manager. If there are suggestions, or conditions that must be met
before final inclusion, they should be stated.</p> before final inclusion, they should be stated.</p>
<h2>Notes for <a name="Review_Manager">Review Manager</a>s</h2> <h2>Notes for <a name="Review_Manager" id="Review_Manager">Review
Manager</a>s</h2>
<p>Before a library can be scheduled for formal review, an active boost <p>Before a library can be scheduled for formal review, an active boost
member not connected with the library submission must volunteer to be the member not connected with the library submission must volunteer to be the
@ -139,19 +163,17 @@
<li>Finalizes the schedule with the <a href="#Wizard">Review Wizard</a> <li>Finalizes the schedule with the <a href="#Wizard">Review Wizard</a>
and the submitter .</li> and the submitter .</li>
<li> <li>Posts a notice of the review schedule on the regular <b><a href=
Posts a notice of the review schedule on the "mailto:boost@lists.boost.org">boost</a></b> mailing list, the
regular <b><a href= "mailto:boost@lists.boost.org">boost</a></b> <b><a href="mailto:boost-users@lists.boost.org">boost-users</a></b>
mailing list, mailing list, and the <b><a href=
the <b><a href="mailto:boost-users@lists.boost.org">boost-users</a></b> "mailto:boost-announce@lists.boost.org">boost-announce</a></b> mailing
mailing list, and the list.
<b><a href="mailto:boost-announce@lists.boost.org">boost-announce</a></b>
mailing list.
<ul> <ul>
<li>The notice should include a brief description of the library <li>The notice should include a brief description of the library and
and what it does, to let readers know if the library is one they what it does, to let readers know if the library is one they are
are interested in reviewing.</li> interested in reviewing.</li>
<li>If the library is known to fail with certain compilers, please <li>If the library is known to fail with certain compilers, please
mention them in the review notice so reviewers with those compilers mention them in the review notice so reviewers with those compilers
@ -170,31 +192,31 @@
<li>Follows review discussions regarding the library, moderating or <li>Follows review discussions regarding the library, moderating or
answering questions as needed.</li> answering questions as needed.</li>
<li>Asks the <a href="#Wizard">review wizard</a> for permission <li>Asks the <a href="#Wizard">review wizard</a> for permission to extend
to extend the review schedule if it appears that too few reviews will the review schedule if it appears that too few reviews will be submitted
be submitted during the review period.</li> during the review period.</li>
<li>Decides if there is consensus to accept the library, and if there <li>Decides if there is consensus to accept the library, and if there are
are any conditions attached.</li> any conditions attached.</li>
<li> <li>Posts a notice of the <a href="#Results">review results</a> on the
Posts a notice of the <a href="#Results">review results</a> on the regular <b><a href="mailto:boost@lists.boost.org">boost</a></b> mailing
regular <b><a href= "mailto:boost@lists.boost.org">boost</a></b> list, the <b><a href=
mailing list, "mailto:boost-users@lists.boost.org">boost-users</a></b> mailing list,
the <b><a href="mailto:boost-users@lists.boost.org">boost-users</a></b> and the <b><a href=
mailing list, and the "mailto:boost-announce@lists.boost.org">boost-announce</a></b> mailing
<b><a href="mailto:boost-announce@lists.boost.org">boost-announce</a></b> list.</li>
mailing list.
</ul> </ul>
<p>In other words, it is the Review Manager's responsibility to make sure <p>In other words, it is the Review Manager's responsibility to make sure
the review process works smoothly.</p> the review process works smoothly.</p>
<h2>Notes for Library <a name="Submitters">Submitters</a></h2> <h2>Notes for Library <a name="Submitters" id=
"Submitters">Submitters</a></h2>
<p>See <a href="submission_process.htm">Submission Process</a> for a <p>See <a href="submission_process.htm">Submission Process</a> for a
description of the steps a library developer goes through to get a description of the steps a library developer goes through to get a library
library accepted by Boost.</p> accepted by Boost.</p>
<p>A proposed library should remain stable during the review period; it <p>A proposed library should remain stable during the review period; it
will just confuse and irritate reviewers if there are numerous will just confuse and irritate reviewers if there are numerous
@ -204,11 +226,11 @@
list.</p> list.</p>
<p>Library improvements suggested by reviewers should normally be held <p>Library improvements suggested by reviewers should normally be held
until after the completion of review period.&nbsp; If the suggested until after the completion of review period.&nbsp; If the suggested changes
changes might affect reviewer's judgments,&nbsp;post a notice of the might affect reviewer's judgments,&nbsp;post a notice of the pending change
pending change on the mailing list.</p> on the mailing list.</p>
<h2>Review <a name="Wizard">Wizard</a></h2> <h2>Review <a name="Wizard" id="Wizard">Wizard</a></h2>
<p>The Review Wizard coordinates the formal review schedule:</p> <p>The Review Wizard coordinates the formal review schedule:</p>
@ -219,8 +241,9 @@
<li>When a formal review is requested for a library:</li> <li>When a formal review is requested for a library:</li>
<li style="list-style: none"> <li style="list-style: none">&nbsp;
&nbsp;<ul>
<ul>
<li>Assign a review manager and suggests a schedule, after checking <li>Assign a review manager and suggests a schedule, after checking
(via private email) availability of the volunteers at the top of (via private email) availability of the volunteers at the top of
review manager queue.</li> review manager queue.</li>
@ -233,57 +256,66 @@
</ul> </ul>
</li> </li>
<li>Maintains a schedule of both past and pending reviews, in the form <li>Maintains a schedule of both past and pending reviews, in the form of
of the <a href="formal_review_schedule.html">Review Schedule</a> web the <a href="formal_review_schedule.html">Review Schedule</a> web
page.</li> page.</li>
<li>Resolves questions from review managers and library submitters, who <li>Resolves questions from review managers and library submitters, who
sometimes want a third opinion on questions such as "Should we extend sometimes want a third opinion on questions such as "Should we extend the
the review period because ...?"</li> review period because ...?"</li>
<li>Monitors the general review process, and makes minor adjustments as <li>Monitors the general review process, and makes minor adjustments as
needed, or queries the list about possible major adjustments.</li> needed, or queries the list about possible major adjustments.</li>
</ul> </ul>The role of Boost Review Wizard is currently played by <a href=
The role of Boost Review Wizard is currently played by <a href= "mailto:reportbase@yahoo.com">Tom Brinkman</a> and Ronald Garcia (garcia at
"mailto:reportbase@yahoo.com">Tom Brinkman</a> and Ronald Garcia cs dot indiana dot edu).
(garcia at cs dot indiana dot edu).
<h2><a name="Fast-Track" id="Fast-Track">Fast Track Reviews</a></h2>
<h2><a name="Fast-Track">Fast Track Reviews</a></h2>
<p>To qualify for fast track review:</p> <p>To qualify for fast track review:</p>
<ul> <ul>
<li>The component must be small.</li> <li>The component must be small.</li>
<li>The technique must be already in use in Boost libraries and the new <li>The technique must be already in use in Boost libraries and the new
component provides a common implementation.</li> component provides a common implementation.</li>
<li>A full Boost-conformant implementation is available in the sandbox.</li>
<li>A full Boost-conformant implementation is available in the
sandbox.</li>
<li>The Review Wizard determines that the proposal qualifies for fast <li>The Review Wizard determines that the proposal qualifies for fast
track review.</li> track review.</li>
</ul> </ul>
<p>Procedure:</p> <p>Procedure:</p>
<ul> <ul>
<li>The Boost Review Wizard posts a review announcement to the main Boost <li>The Boost Review Wizard posts a review announcement to the main Boost
developer's list. The review period will normally last for 5 days. No two developer's list. The review period will normally last for 5 days. No two
fast track reviews will run in parallel. Fast track reviews may run during fast track reviews will run in parallel. Fast track reviews may run
full reviews, though generally this is to be avoided.</li> during full reviews, though generally this is to be avoided.</li>
<li>After the review period ends, the submitter will post a review summary
containing proposed changes to the reviewed implementation.</li> <li>After the review period ends, the submitter will post a review
summary containing proposed changes to the reviewed implementation.</li>
<li>The Review Wizard will accept or reject the proposed library and <li>The Review Wizard will accept or reject the proposed library and
proposed changes.</li> proposed changes.</li>
<li>After applying the proposed changes, the component is checked into CVS
like any other library.<br> <li>After applying the proposed changes, the component is checked into
CVS like any other library.<br>
&nbsp;</li> &nbsp;</li>
</ul> </ul>
<hr> <hr>
<p>Revised <p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->15 October, 2003<!--webbot bot="Timestamp" endspan i-checksum="38556" --></p> <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->15
October, 2003<!--webbot bot="Timestamp" endspan i-checksum="38556" --></p>
<p>© Copyright Beman Dawes 2000</p> <p>&copy; Copyright Beman Dawes 2000</p>
<p>
Distributed under the Boost Software License, Version 1.0. (See <p>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
at <a href= at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>) "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
</p>
</body> </body>
</html> </html>