Big admonition at top about following the submission process.

[SVN r37986]
This commit is contained in:
Dave Abrahams 2007-06-13 21:30:36 +00:00
parent e29ee19738
commit 2b0fd4cf25

View File

@ -9,281 +9,313 @@
<meta name="GENERATOR" content="Microsoft FrontPage 5.0"> <meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<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>
</head> <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>
<body bgcolor="#FFFFFF" text="#000000"> <body bgcolor="#FFFFFF" text="#000000">
<table border="1" bgcolor="#007F7F" cellpadding="2"> <table border="1" bgcolor="#007F7F" cellpadding="2">
<tr> <tr>
<td bgcolor="#FFFFFF"><img src="../boost.png" alt= <td bgcolor="#FFFFFF"><img src="../boost.png" alt=
"boost.png (6897 bytes)" width="277" height="86"></td> "boost.png (6897 bytes)" width="277" height="86"></td>
<td><a href="../index.htm"><font face="Arial" color= <td><a href="../index.htm"><font face="Arial" color=
"#FFFFFF"><big>Home</big></font></a></td> "#FFFFFF"><big>Home</big></font></a></td>
<td><a href="../libs/libraries.htm"><font face="Arial" color= <td><a href="../libs/libraries.htm"><font face="Arial" color=
"#FFFFFF"><big>Libraries</big></font></a></td> "#FFFFFF"><big>Libraries</big></font></a></td>
<td><a href="../people/people.htm"><font face="Arial" color= <td><a href="../people/people.htm"><font face="Arial" color=
"#FFFFFF"><big>People</big></font></a></td> "#FFFFFF"><big>People</big></font></a></td>
<td><a href="faq.htm"><font face="Arial" color= <td><a href="faq.htm"><font face="Arial" color=
"#FFFFFF"><big>FAQ</big></font></a></td> "#FFFFFF"><big>FAQ</big></font></a></td>
<td><a href="index.htm"><font face="Arial" color= <td><a href="index.htm"><font face="Arial" color=
"#FFFFFF"><big>More</big></font></a></td> "#FFFFFF"><big>More</big></font></a></td>
</tr> </tr>
</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>
<a href="#Results">Results</a><br> <a href="#Results">Results</a><br>
<a href="#Review_Manager">Notes for Review Managers</a><br> <a href="#Review_Manager">Notes for Review Managers</a><br>
<a href="#Submitters">Notes for Library Submitters</a><br> <a href="#Submitters">Notes for Library Submitters</a><br>
<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>
<blockquote>
<ul>
<li>Publicly on the mailing list.</li>
<li>Privately to the Review Manager.</li>
</ul>
</blockquote>
<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 are
preferred.</p>
<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 Manager
needs your evaluation of the library.&nbsp; If you identify problems along
the way, please note if they are minor, serious, or showstoppers.</p>
<p>Here are some questions you might want to answer in your review:</p>
<ul>
<li>What is your evaluation of the design?<br></li>
<li>What is your evaluation of the implementation?<br></li>
<li>What is your evaluation of the documentation?<br></li>
<li>What is your evaluation of the potential usefulness of the
library?<br></li>
<li>Did you try to use the library?&nbsp; With what compiler?&nbsp; Did
you have any problems?<br></li>
<li>How much effort did you put into your evaluation? A glance? A quick
reading? In-depth study?<br></li>
<li>Are you knowledgeable about the problem domain?</li>
</ul>
<p>And finally, every review should answer this question:<br></p>
<ul>
<li>Do you think the library should be accepted as a Boost library?&nbsp;
Be sure to say this explicitly so that your other comments don't obscure
your overall opinion.</li>
</ul>
<h2><a name="Results" id="Results">Results</a></h2>
<p>At the conclusion of the comment period, the Review Manager will post a
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
Review Manager. If there are suggestions, or conditions that must be met
before final inclusion, they should be stated.</p>
<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
member not connected with the library submission must volunteer to be the
"Review Manager" for the library.</p>
<p>The Review Manager:</p>
<ul>
<li>Checks the submission to make sure it really is complete enough to
warrant formal review.&nbsp; See the <a href="lib_guide.htm">Boost
Library Requirements and Guidelines</a>.&nbsp; If necessary, work with
the submitter to verify the code compiles and runs correctly on several
compilers and platforms.</li>
<li>Finalizes the schedule with the <a href="#Wizard">Review Wizard</a>
and the submitter .</li>
<li>Posts a notice of the review schedule on the regular <b><a href=
"mailto:boost@lists.boost.org">boost</a></b> mailing list, the
<b><a href="mailto:boost-users@lists.boost.org">boost-users</a></b>
mailing list, and the <b><a href=
"mailto:boost-announce@lists.boost.org">boost-announce</a></b> mailing
list.
<blockquote>
<ul> <ul>
<li>Publicly on the mailing list.</li> <li>The notice should include a brief description of the library and
what it does, to let readers know if the library is one they are
interested in reviewing.</li>
<li>Privately to the Review Manager.</li> <li>If the library is known to fail with certain compilers, please
mention them in the review notice so reviewers with those compilers
won't waste time diagnosing known problems.</li>
</ul> </ul>
</blockquote> </li>
<p>Private comments to a library submitter may be helpful to her or him, <li>Inspects the Boost <a href="../libs/libraries.htm">library
but won't help the Review Manager reach a decision, so the other forms catalogue</a> for libraries which may interact with the new submission.
are preferred.</p> These potential interactions should be pointed out in the review
announcement, and the author(s) of these libraries should be privately
notified and urged to participate in the review.</li>
<h2>What to include in Review <a name="Comments">Comments</a></h2> <li>Urges people to do reviews if they aren't forthcoming.</li>
<p>Your comments may be brief or lengthy, but basically the Review <li>Follows review discussions regarding the library, moderating or
Manager needs your evaluation of the library.&nbsp; If you identify answering questions as needed.</li>
problems along the way, please note if they are minor, serious, or
showstoppers.</p>
<p>Here are some questions you might want to answer in your review:</p> <li>Asks the <a href="#Wizard">review wizard</a> for permission to extend
the review schedule if it appears that too few reviews will be submitted
during the review period.</li>
<ul> <li>Decides if there is consensus to accept the library, and if there are
<li>What is your evaluation of the design?<br> any conditions attached.</li>
</li>
<li>What is your evaluation of the implementation?<br> <li>Posts a notice of the <a href="#Results">review results</a> on the
</li> regular <b><a href="mailto:boost@lists.boost.org">boost</a></b> mailing
list, the <b><a href=
"mailto:boost-users@lists.boost.org">boost-users</a></b> mailing list,
and the <b><a href=
"mailto:boost-announce@lists.boost.org">boost-announce</a></b> mailing
list.</li>
</ul>
<li>What is your evaluation of the documentation?<br> <p>In other words, it is the Review Manager's responsibility to make sure
</li> the review process works smoothly.</p>
<li>What is your evaluation of the potential usefulness of the <h2>Notes for Library <a name="Submitters" id=
library?<br> "Submitters">Submitters</a></h2>
</li>
<li>Did you try to use the library?&nbsp; With what compiler?&nbsp; Did <p>See <a href="submission_process.htm">Submission Process</a> for a
you have any problems?<br> description of the steps a library developer goes through to get a library
</li> accepted by Boost.</p>
<li>How much effort did you put into your evaluation? A glance? A quick <p>A proposed library should remain stable during the review period; it
reading? In-depth study?<br> will just confuse and irritate reviewers if there are numerous
</li> changes.&nbsp; It is, however, useful to upload fixes for serious bugs
right away, particularly those which prevent reviewers from fully
evaluating the library.&nbsp; Post a notice of such fixes on the mailing
list.</p>
<li>Are you knowledgeable about the problem domain?</li> <p>Library improvements suggested by reviewers should normally be held
</ul> until after the completion of review period.&nbsp; If the suggested changes
might affect reviewer's judgments,&nbsp;post a notice of the pending change
on the mailing list.</p>
<p>And finally, every review should answer this question:<br> <h2>Review <a name="Wizard" id="Wizard">Wizard</a></h2>
</p>
<ul> <p>The Review Wizard coordinates the formal review schedule:</p>
<li>Do you think the library should be accepted as a Boost
library?&nbsp; Be sure to say this explicitly so that your other
comments don't obscure your overall opinion.</li>
</ul>
<h2><a name="Results">Results</a></h2> <ul>
<li>Maintains a list of review manager volunteers, in the form of a
queue, so that volunteers who least recently managed reviews become the
prime candidates for upcoming reviews.</li>
<p>At the conclusion of the comment period, the Review Manager will post <li>When a formal review is requested for a library:</li>
a 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
Review Manager. If there are suggestions, or conditions that must be met
before final inclusion, they should be stated.</p>
<h2>Notes for <a name="Review_Manager">Review Manager</a>s</h2> <li style="list-style: none">&nbsp;
<p>Before a library can be scheduled for formal review, an active boost <ul>
member not connected with the library submission must volunteer to be the <li>Assign a review manager and suggests a schedule, after checking
"Review Manager" for the library.</p> (via private email) availability of the volunteers at the top of
review manager queue.</li>
<p>The Review Manager:</p> <li>Finalize the schedule, once the review manager verifies the
library is actually ready for review.</li>
<ul> <li>Resolve schedule slips or other issues with review managers and
<li>Checks the submission to make sure it really is complete enough to submitters.</li>
warrant formal review.&nbsp; See the <a href="lib_guide.htm">Boost </ul>
Library Requirements and Guidelines</a>.&nbsp; If necessary, work with </li>
the submitter to verify the code compiles and runs correctly on several
compilers and platforms.</li>
<li>Finalizes the schedule with the <a href="#Wizard">Review Wizard</a> <li>Maintains a schedule of both past and pending reviews, in the form of
and the submitter .</li> the <a href="formal_review_schedule.html">Review Schedule</a> web
page.</li>
<li> <li>Resolves questions from review managers and library submitters, who
Posts a notice of the review schedule on the sometimes want a third opinion on questions such as "Should we extend the
regular <b><a href= "mailto:boost@lists.boost.org">boost</a></b> review period because ...?"</li>
mailing list,
the <b><a href="mailto:boost-users@lists.boost.org">boost-users</a></b>
mailing list, and the
<b><a href="mailto:boost-announce@lists.boost.org">boost-announce</a></b>
mailing list.
<ul> <li>Monitors the general review process, and makes minor adjustments as
<li>The notice should include a brief description of the library needed, or queries the list about possible major adjustments.</li>
and what it does, to let readers know if the library is one they </ul>The role of Boost Review Wizard is currently played by <a href=
are interested in reviewing.</li> "mailto:reportbase@yahoo.com">Tom Brinkman</a> and Ronald Garcia (garcia at
cs dot indiana dot edu).
<li>If the library is known to fail with certain compilers, please <h2><a name="Fast-Track" id="Fast-Track">Fast Track Reviews</a></h2>
mention them in the review notice so reviewers with those compilers
won't waste time diagnosing known problems.</li>
</ul>
</li>
<li>Inspects the Boost <a href="../libs/libraries.htm">library <p>To qualify for fast track review:</p>
catalogue</a> for libraries which may interact with the new submission.
These potential interactions should be pointed out in the review
announcement, and the author(s) of these libraries should be privately
notified and urged to participate in the review.</li>
<li>Urges people to do reviews if they aren't forthcoming.</li> <ul>
<li>The component must be small.</li>
<li>Follows review discussions regarding the library, moderating or <li>The technique must be already in use in Boost libraries and the new
answering questions as needed.</li> component provides a common implementation.</li>
<li>Asks the <a href="#Wizard">review wizard</a> for permission <li>A full Boost-conformant implementation is available in the
to extend the review schedule if it appears that too few reviews will sandbox.</li>
be submitted during the review period.</li>
<li>Decides if there is consensus to accept the library, and if there <li>The Review Wizard determines that the proposal qualifies for fast
are any conditions attached.</li> track review.</li>
</ul>
<li> <p>Procedure:</p>
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 list,
the <b><a href="mailto:boost-users@lists.boost.org">boost-users</a></b>
mailing list, and the
<b><a href="mailto:boost-announce@lists.boost.org">boost-announce</a></b>
mailing list.
</ul>
<p>In other words, it is the Review Manager's responsibility to make sure <ul>
the review process works smoothly.</p> <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
fast track reviews will run in parallel. Fast track reviews may run
during full reviews, though generally this is to be avoided.</li>
<h2>Notes for Library <a name="Submitters">Submitters</a></h2> <li>After the review period ends, the submitter will post a review
summary containing proposed changes to the reviewed implementation.</li>
<p>See <a href="submission_process.htm">Submission Process</a> for a <li>The Review Wizard will accept or reject the proposed library and
description of the steps a library developer goes through to get a proposed changes.</li>
library accepted by Boost.</p>
<p>A proposed library should remain stable during the review period; it <li>After applying the proposed changes, the component is checked into
will just confuse and irritate reviewers if there are numerous CVS like any other library.<br>
changes.&nbsp; It is, however, useful to upload fixes for serious bugs &nbsp;</li>
right away, particularly those which prevent reviewers from fully </ul>
evaluating the library.&nbsp; Post a notice of such fixes on the mailing <hr>
list.</p>
<p>Library improvements suggested by reviewers should normally be held <p>Revised
until after the completion of review period.&nbsp; If the suggested <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->15
changes might affect reviewer's judgments,&nbsp;post a notice of the October, 2003<!--webbot bot="Timestamp" endspan i-checksum="38556" --></p>
pending change on the mailing list.</p>
<h2>Review <a name="Wizard">Wizard</a></h2> <p>&copy; Copyright Beman Dawes 2000</p>
<p>The Review Wizard coordinates the formal review schedule:</p> <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
<ul> at <a href=
<li>Maintains a list of review manager volunteers, in the form of a "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
queue, so that volunteers who least recently managed reviews become the </body>
prime candidates for upcoming reviews.</li>
<li>When a formal review is requested for a library:</li>
<li style="list-style: none">
&nbsp;<ul>
<li>Assign a review manager and suggests a schedule, after checking
(via private email) availability of the volunteers at the top of
review manager queue.</li>
<li>Finalize the schedule, once the review manager verifies the
library is actually ready for review.</li>
<li>Resolve schedule slips or other issues with review managers and
submitters.</li>
</ul>
</li>
<li>Maintains a schedule of both past and pending reviews, in the form
of the <a href="formal_review_schedule.html">Review Schedule</a> web
page.</li>
<li>Resolves questions from review managers and library submitters, who
sometimes want a third opinion on questions such as "Should we extend
the review period because ...?"</li>
<li>Monitors the general review process, and makes minor adjustments as
needed, or queries the list about possible major adjustments.</li>
</ul>
The role of Boost Review Wizard is currently played by <a href=
"mailto:reportbase@yahoo.com">Tom Brinkman</a> and Ronald Garcia
(garcia at cs dot indiana dot edu).
<h2><a name="Fast-Track">Fast Track Reviews</a></h2>
<p>To qualify for fast track review:</p>
<ul>
<li>The component must be small.</li>
<li>The technique must be already in use in Boost libraries and the new
component provides a common implementation.</li>
<li>A full Boost-conformant implementation is available in the sandbox.</li>
<li>The Review Wizard determines that the proposal qualifies for fast
track review.</li>
</ul>
<p>Procedure:</p>
<ul>
<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
fast track reviews will run in parallel. Fast track reviews may run 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>The Review Wizard will accept or reject the proposed library and
proposed changes.</li>
<li>After applying the proposed changes, the component is checked into CVS
like any other library.<br>
&nbsp;</li>
</ul>
<hr>
<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>
<p>© Copyright Beman Dawes 2000</p>
<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
at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</body>
</html> </html>