diff --git a/formal_review_process.htm b/formal_review_process.htm index 2cef981..705ff90 100644 --- a/formal_review_process.htm +++ b/formal_review_process.htm @@ -20,36 +20,35 @@ </tr> </table> <h1>Boost Formal Review Process</h1> -<p>The Formal Review process determines if a proposed library should be accepted -as a Boost library.</p> +<p><a href="#Introduction">Introduction</a><br> +<a href="#Comments">What to include in Review Comments</a><br> +<a href="#Results">Results</a><br> +<a href="#Review Manager">Notes for Review Managers</a><br> +<a href="#Submitters">Notes for Library Submitters</a><br> +<a href="#Wizard">Review Wizard</a></p> +<h2><a name="Introduction">Introduction</a></h2> +<p>Proposed libraries are accepted into Boost only after undergoing a formal +review, where Boost mailing list members comment on their evaluation of the +library.</p> <p>The final "accept" or "reject" decision is made by the <a href="#Review Manager"> -Review Manager</a>, based on review comments received from boost mailing list +Review Manager</a>, based on the review comments received from boost mailing list members.</p> -<p>Reviews are scheduled so that:</p> -<ul> - <li>Each library gets review time proportional to its size, complexity, and - importance.</li> - <li>Only a small number of libraries are under active review at any one time.</li> - <li>Members know ahead of time when a particular library will be under active - review. </li> -</ul> -<h2>Comments</h2> <p> Boost mailing list members are encouraged to submit Formal Review comments:</p> <blockquote> <ul> <li>Publicly on the mailing list.</li> <li>Privately to the Review Manager.</li> - <li>Privately to the library submitter.</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>Preparing review comments</h2> -<p>Comments may be brief or lengthy, but basically the Review Manager needs your -answers to several questions. If you identify problems along the way, +<h2>What to include in Review <a name="Comments">Comments</a></h2> +<p>Your comments may be brief or lengthy, but basically the Review Manager needs your +evaluation of the library. 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> @@ -65,30 +64,34 @@ please note if they are minor, serious, or showstoppers.</p> <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?<br> - </li> - <li>Finally, do you think the library should be accepted as a Boost + <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? Be sure to say this explicitly so that your other comments don't obscure your overall opinion.</li> </ul> -<h2>Results</h2> +<h2><a name="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. A rationale should be provided, but its extent is up to the -Review Manager.</p> +rejected. 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> <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> +<p>The Review Manager:</p> <ul> <li>Checks the submission to make sure it really is complete enough to warrant formal review. See the <a href="lib_guide.htm">Boost Library Requirements and Guidelines</a>. If necessary, work with the submitter to verify the code compiles and runs correctly on several compilers and platforms.</li> - <li>Sets the schedule, after discussion with the boost webmaster, currently - Beman Dawes.</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 both the regular <b> boost mailing list</b> and the <b> boost-announce mailing list</b>.<ul> <li>The notice should include a brief description of the library and what it @@ -112,24 +115,53 @@ Manager" for the library.</p> <li>Decides if there is consensus to accept the library, and if there are any conditions attached.</li> - <li>Posts a message on both the <b>boost</b> and <b>boost-announce</b> lists informing members of the review - results.</li> + <li>Posts a message on both the <b>boost</b> and <b>boost-announce</b> lists informing members of the + <a href="#Results">review + results</a>.</li> </ul> <p>In other words, it is the Review Manager's responsibility to make sure the review process works smoothly.</p> -<h2>Notes for Library Authors</h2> +<h2>Notes for Library <a name="Submitters">Submitters</a></h2> <p>A proposed library should remain stable during the review period; it will just confuse and irritate reviewers if there are numerous changes. It is, however, useful to upload fixes for serious bugs right away, particularly those which prevent reviewers from fully evaluating the library. Post a notice of such fixes on the mailing list.</p> -<p>Library improvements suggested by reviewers should be held until after the -completion of review period. Such changes can then be incorporated in the <a href="submission_process.htm#Final">final -submission file</a> sent to the webmaster for posting. If the suggested +<p>Library improvements suggested by reviewers should normally be held until +after the completion of review period. If the suggested changes might affect reviewer's judgments, post a notice of the pending change on the mailing list.</p> +<p>Once an accepted library is ready for inclusion on the Boost web site, the +submitter is typically given Boost CVS write access, and expected to check-in +and maintain the library in the CVS. Contact the moderators if you need write +access or CVS use isn't possible for you.</p> +<h2>Review <a name="Wizard">Wizard</a></h2> +<p>The Review Wizard coordinates the formal review schedule:</p> +<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> + <li>When a formal review is requested for a library: </li> + <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>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> <hr> -<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->18 March, 2002<!--webbot bot="Timestamp" endspan i-checksum="28813" --></p> +<p>Revised +<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->08 May, 2002<!--webbot bot="Timestamp" endspan i-checksum="13978" --></p> <p> </p> </body>