formal_review_process.htm 9.2 KB

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