submission_process.htm 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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 Library Submission 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="../boost.png" alt="boost.png (6897 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 Library Submission Process</h1>
  20. <p>This page describes the process a library developer goes through to get a
  21. library accepted by Boost.</p>
  22. <p>See the <a href="lib_guide.htm">Boost Library Requirements and Guidelines</a>
  23. page for issues of content.</p>
  24. <h3><b>Steps for getting a library accepted by Boost:</b></h3>
  25. <ul>
  26. <li><a href="#Learn">Learn about Boost</a>.</li>
  27. <li><a href="#interest">Determine interest</a>.</li>
  28. <li><a href="#Preliminary">Preliminary submission</a>.</li>
  29. <li><a href="#Refinement">Refinement</a>.</li>
  30. <li><a href="#Submission">Submission for review</a>.</li>
  31. <li><a href="#Review">Formal Review</a>.</li>
  32. <li><a href="#site posting">Web site posting</a>.</li>
  33. <li><a href="#People">People page.</a></li>
  34. <li><a href="#Lifecycle">Lifecycle</a>.</li>
  35. </ul>
  36. <h2><a name="Learn">Learn</a> about Boost</h2>
  37. <p>Subscribe to the <a href="mailing_lists.htm#main">main developers mailing list</a> for a
  38. while, or look through the <a href="mailing_lists.htm#archive">archives</a>.&nbsp;
  39. Click around the <a href="../index.htm">web site</a>.&nbsp; Understand the <a href="lib_guide.htm">Requirements</a>.&nbsp;
  40. Read the rest of this page to learn about the process.&nbsp; Otherwise, you will
  41. just end up wasting everyone's time.</p>
  42. <p>There is a culture associated with Boost, aimed at encouraging high quality
  43. libraries by a process of discussion and refinement.</p>
  44. <p>If what you really want is a site that will just post your library without
  45. even looking at it, you should go elsewhere.</p>
  46. <h2>Determine <a name="interest">interest</a></h2>
  47. <p>Potential library submitters should use the Boost developers <a href="mailing_lists.htm">mailing
  48. list</a> as a forum to gauge interest a possible submission.</p>
  49. <p>A message might be as simple as &quot;Is there any interest in a library
  50. which solves Traveling Salesperson problems in linear time?&quot;</p>
  51. <p>A bit of further description or snippet of code may be helpful. Messages
  52. should be plain text; not rich text, HTML, etc.</p>
  53. <p>Please don't post lengthy descriptions, documentation, or code to the mailing
  54. list, and no attachments, even small ones.&nbsp; Please post lengthy material in
  55. the boost <a href="http://boost-sandbox.sourceforge.net/vault/">Sandbox Vault</a>.&nbsp;</p>
  56. <h2><a name="Preliminary">Preliminary</a> submission</h2>
  57. <p>If response to an initial query indicates interest, then post the preliminary
  58. submission files in the <a href="http://boost-sandbox.sourceforge.net/vault/">Sandbox Vault</a> on
  59. the sourceforge web site if you haven't already done so.</p>
  60. <h2><a name="Refinement">Refinement</a></h2>
  61. <p>Discuss, refine, resubmit.&nbsp; Repeat until satisfied.</p>
  62. <p>The exact details of this process varies a lot.&nbsp; Sometimes it is public,
  63. on the mailing list, sometimes a lot of discussion happens in private
  64. emails.&nbsp; For some libraries the process is over quickly, for others it goes
  65. on for months.&nbsp; It's often challenging, and sometimes leads off in
  66. completely unexpected directions.&nbsp;&nbsp;</p>
  67. <p>The <a href="mailing_lists.htm#archive">archive</a> of past
  68. messages is one way to see how this process worked for other Boost
  69. libraries.</p>
  70. <h2><a name="Submission">Submission</a> for review&nbsp;</h2>
  71. <p>All of the files which make up the library should be combined and compressed
  72. into a single submission file using the .zip format.&nbsp; Free encoders
  73. and decoders for this format running on many different platforms are available
  74. at the <a href="http://www.info-zip.org/pub/infozip/">Info-ZIP</a> web site, which
  75. includes a FAQ and much other useful information about the .zip format. Many
  76. commercial compressor-archiver utilities also support this format.</p>
  77. <p>The submission file should contain material as if on the
  78. boost.org web site.&nbsp; The closer the submission file mirrors the final
  79. <a href="lib_guide.htm#Directory_structure">directory
  80. structure</a> and format of the web site, the better.
  81. <p>Like a preliminary submission, post the final submission .zip file in the <a href="http://boost-sandbox.sourceforge.net/vault/">Sandbox Vault</a> of
  82. the sourceforge site.
  83. <h2>Formal <a name="Review">Review</a></h2>
  84. <p>Before asking for formal review, your submission should be posted in the
  85. Boost files/vault. Please verify that your submission compiles
  86. and runs under at least two compilers.&nbsp; This flushes out obvious
  87. portability problems.&nbsp; If you don't have access to a second compiler, ask
  88. for help on the Boost mailing list.</p>
  89. <p>Once a library author feels a submission (which presumably is now in the
  90. files/vault) has matured enough for formal review, the author sends a message
  91. requesting a formal review to the mailing list.&nbsp; Please use a subject in
  92. the form &quot;Review Request: library&quot; where <i>library</i> is replaced by
  93. the library name.</p>
  94. <p>See <a href="formal_review_process.htm">Formal Review Process</a> for
  95. details.</p>
  96. <p>Formal Review schedules are posted on
  97. the <a href="formal_review_schedule.html">web site</a>.&nbsp;</p>
  98. <h2>Boost web <a name="site posting">site posting</a></h2>
  99. <p>Once an accepted library is ready for inclusion on the Boost web site, the
  100. submitter is typically given Boost CVS write access, and expected to check-in
  101. and maintain the library in the CVS. Contact the moderators if you need write
  102. access or CVS use isn't possible for you.</p>
  103. <h2><a name="People">People</a> page</h2>
  104. <p>If the boost.org web site doesn't already have your capsule biography
  105. and&nbsp; picture (optional, with not-too-serious pictures preferred), please
  106. send them to the Boost webmaster. It is
  107. up to you as to whether or not the biography includes your email address or
  108. other contact information.&nbsp; The preferred picture format is .jpg, but other
  109. common formats are acceptable.&nbsp; The preferred image size is 500x375 but the
  110. webmaster has photo editing software and can do the image preparation if
  111. necessary.</p>
  112. <h2><a name="Lifecycle">Lifecycle</a></h2>
  113. <p>Libraries are software; they lose their value over time if not maintained.
  114. Postings on the Boost developers or users mailing lists can alert you to
  115. potential maintenance needs; please plan to maintain your library over time. If
  116. you no longer can or wish to maintain your library, please post a message on the
  117. Boost developers mailing list and help someone else take over as the library
  118. maintainer.</p>
  119. <hr>
  120. <p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->26 November, 2003<!--webbot bot="Timestamp" endspan i-checksum="39365" --></p>
  121. <p>© Copyright Beman Dawes 2000</p>
  122. <p>Use, modification, and distribution are subject to the Boost Software License,
  123. Version 1.0. (See accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy at
  124. <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</p>
  125. </body>
  126. </html>
粤ICP备19079148号