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