formal_review_process.htm 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
  4. <meta name="GENERATOR" content="Microsoft FrontPage 5.0">
  5. <meta name="ProgId" content="FrontPage.Editor.Document">
  6. <title>Boost Formal Review Process</title>
  7. </head>
  8. <body bgcolor="#FFFFFF" text="#000000">
  9. <table border="1" bgcolor="#007F7F" cellpadding="2">
  10. <tr>
  11. <td bgcolor="#FFFFFF"><img src="../c++boost.gif" alt="c++boost.gif (8819 bytes)" width="277" height="86"></td>
  12. <td><a href="../index.htm"><font face="Arial" color="#FFFFFF"><big>Home</big></font></a></td>
  13. <td><a href="../libs/libraries.htm"><font face="Arial" color="#FFFFFF"><big>Libraries</big></font></a></td>
  14. <td><a href="../people/people.htm"><font face="Arial" color="#FFFFFF"><big>People</big></font></a></td>
  15. <td><a href="faq.htm"><font face="Arial" color="#FFFFFF"><big>FAQ</big></font></a></td>
  16. <td><a href="index.htm"><font face="Arial" color="#FFFFFF"><big>More</big></font></a></td>
  17. </tr>
  18. </table>
  19. <h1>Boost Formal Review Process</h1>
  20. <p><a href="#Introduction">Introduction</a><br>
  21. <a href="#Comments">What to include in Review Comments</a><br>
  22. <a href="#Results">Results</a><br>
  23. <a href="#Review Manager">Notes for Review Managers</a><br>
  24. <a href="#Submitters">Notes for Library Submitters</a><br>
  25. <a href="#Wizard">Review Wizard</a></p>
  26. <h2><a name="Introduction">Introduction</a></h2>
  27. <p>Proposed libraries are accepted into Boost only after undergoing a formal
  28. review, where Boost mailing list members comment on their evaluation of the
  29. library.</p>
  30. <p>The final &quot;accept&quot; or &quot;reject&quot; decision is made by the <a href="#Review Manager">
  31. Review Manager</a>, based on the review comments received from boost mailing list
  32. members.</p>
  33. <p> Boost mailing list members are encouraged to submit Formal Review
  34. comments:</p>
  35. <blockquote>
  36. <ul>
  37. <li>Publicly on the mailing list.</li>
  38. <li>Privately to the Review Manager.</li>
  39. </ul>
  40. </blockquote>
  41. <p>Private comments to a library submitter may be helpful to her or him, but
  42. won't help the Review Manager reach a decision, so the other forms are
  43. preferred.</p>
  44. <h2>What to include in Review <a name="Comments">Comments</a></h2>
  45. <p>Your comments may be brief or lengthy, but basically the Review Manager needs your
  46. evaluation of the library.&nbsp; If you identify problems along the way,
  47. please note if they are minor, serious, or showstoppers.</p>
  48. <p>Here are some questions you might want to answer in your review:</p>
  49. <ul>
  50. <li>What is your evaluation of the design?<br>
  51. </li>
  52. <li>What is your evaluation of the implementation?<br>
  53. </li>
  54. <li>What is your evaluation of the documentation?<br>
  55. </li>
  56. <li>What is your evaluation of the potential usefulness of the library?<br>
  57. </li>
  58. <li>Did you try to use the library?&nbsp; With what compiler?&nbsp; Did you
  59. have any problems?<br>
  60. </li>
  61. <li>How much effort did you put into your evaluation? A glance? A quick
  62. reading? In-depth study?<br>
  63. </li>
  64. <li>Are you knowledgeable about the problem domain?</li>
  65. </ul>
  66. <p>And finally, every review should answer this question:<br>
  67. </p>
  68. <ul>
  69. <li>Do you think the library should be accepted as a Boost
  70. library?&nbsp; Be sure to say this explicitly so that your other comments
  71. don't obscure your overall opinion.</li>
  72. </ul>
  73. <h2><a name="Results">Results</a></h2>
  74. <p>At the conclusion of the comment period, the Review Manager will post a
  75. message to the mailing list saying if the library has been accepted or
  76. rejected.&nbsp; A rationale is also helpful, but its extent is up to the
  77. Review Manager. If there are suggestions, or conditions that must be met before
  78. final inclusion, they should be stated.</p>
  79. <h2>Notes for <a name="Review Manager"> Review Manager</a>s</h2>
  80. <p>Before a library can be scheduled for formal review, an active boost member not
  81. connected with the library submission must volunteer to be the &quot;Review
  82. Manager&quot; for the library.</p>
  83. <p>The Review Manager:</p>
  84. <ul>
  85. <li>Checks the submission to make sure it really is complete enough to warrant
  86. formal review.&nbsp; See the <a href="lib_guide.htm">Boost Library
  87. Requirements and Guidelines</a>.&nbsp; If necessary, work with the submitter
  88. to verify the code compiles and runs correctly on several compilers and
  89. platforms.</li>
  90. <li>Finalizes the schedule with the
  91. <a href="#Wizard">Review Wizard</a> and the submitter .</li>
  92. <li>Posts a notice of the review schedule on both the regular <b>
  93. <a href="mailto:boost@lists.boost.org">boost mailing list</a></b> and the <b>
  94. <a href="mailto:boost-announce@lists.boost.org">boost-announce</a> mailing list</b>.<ul>
  95. <li>The notice should include a brief description of the library and what it
  96. does, to let readers know if the library is one they are interested in
  97. reviewing.</li>
  98. <li>If the library is known to fail with certain compilers, please mention
  99. them in the review notice so reviewers with those compilers won't waste time
  100. diagnosing known problems.</li>
  101. </ul>
  102. </li>
  103. <li>Inspects the Boost <a href="../libs/libraries.htm">library catalogue</a> for
  104. libraries which may interact with the new submission. These potential
  105. interactions should be pointed out in the review announcement, and the
  106. author(s) of these libraries should be privately notified and urged to
  107. participate in the review.
  108. <li>Urges people to do reviews if they aren't forthcoming.</li>
  109. <li>Follows review discussions regarding the library, moderating or answering
  110. questions as needed.</li>
  111. <li>Decides if
  112. there is consensus to accept the library, and if there are any conditions
  113. attached.</li>
  114. <li>Posts a message on both the <b><a href="mailto:boost@lists.boost.org">boost</a></b> and <b>
  115. <a href="mailto:boost-announce@lists.boost.org">boost-announce</a></b> lists informing members of the
  116. <a href="#Results">review
  117. results</a>.</li>
  118. </ul>
  119. <p>In other words, it is the Review Manager's responsibility to make sure the
  120. review process works smoothly.</p>
  121. <h2>Notes for Library <a name="Submitters">Submitters</a></h2>
  122. <p>See <a href="submission_process.htm">Submission Process</a> for a description
  123. of the steps a library developer goes through to get a library accepted by
  124. Boost.</p>
  125. <p>A proposed library should remain stable during the review period; it will just
  126. confuse and irritate reviewers if there are numerous changes.&nbsp; It
  127. is, however, useful to upload fixes for serious bugs right away, particularly
  128. those which prevent reviewers from fully evaluating the library.&nbsp; Post a
  129. notice of such fixes on the mailing list.</p>
  130. <p>Library improvements suggested by reviewers should normally be held until
  131. after the completion of review period.&nbsp; If the suggested
  132. changes might affect reviewer's judgments,&nbsp;post a notice of the pending
  133. change on the mailing list.</p>
  134. <h2>Review <a name="Wizard">Wizard</a></h2>
  135. <p>The Review Wizard coordinates the formal review schedule:</p>
  136. <ul>
  137. <li>Maintains a list of review manager volunteers, in the form of a queue, so
  138. that volunteers who least recently managed reviews become the prime candidates
  139. for upcoming reviews.</li>
  140. <li>When a formal review is requested for a library: </li>
  141. <ul>
  142. <li>Assign a review manager and suggests a schedule, after checking (via
  143. private email) availability of the volunteers at the top of review manager
  144. queue.</li>
  145. <li>Finalize the schedule, once the review manager verifies the library is
  146. actually ready for review.</li>
  147. <li>Resolve schedule slips or other issues with review managers and
  148. submitters.</li>
  149. </ul>
  150. <li>Maintains a schedule of both past and pending reviews, in the form of the
  151. <a href="formal_review_schedule.html">Review Schedule</a> web page.</li>
  152. <li>Resolves questions from review managers and library submitters, who
  153. sometimes want a third opinion on questions such as &quot;Should we extend the
  154. review period because ...?&quot;</li>
  155. <li>Monitors the general review process, and makes minor adjustments as
  156. needed, or queries the list about possible major adjustments.</li>
  157. </ul>
  158. <hr>
  159. <p>Revised
  160. <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->20 August, 2002<!--webbot bot="Timestamp" endspan i-checksum="34406" --></p>
  161. <p>&nbsp;</p>
  162. </body>
  163. </html>
粤ICP备19079148号