Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/more/submission_process.htm @ 29

Last change on this file since 29 was 29, checked in by landauf, 16 years ago

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