boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2025-02-27 09:40:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add library naming policy

Browse Source 
[SVN r27805]
This commit is contained in:
Dave Abrahams 2005-03-24 18:08:26 +00:00
parent ab563c84ba
commit 96eb9694e1
1 changed files with 36 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
discussion_policy.htm
View File

@ -35,6 +35,7 @@ and dies.</p>
<dt><a href="#quoting">Effective Posting</a><dd>
<dt><a href="#behavior">Prohibited Behavior</a><dd>
<dt><a href="#culture">Culture</a><dd>
<dt><a href="#lib_names">Library Names</a><dd>
</dl>
<h2><a name="acceptable"></a>Acceptable topics</h2>
@ -49,7 +50,7 @@ and dies.</p>
</ul>
<p>Other topics related to boost development may be acceptable, at the discretion of moderators. If unsure, go ahead and post. The moderators
will let you know.</p>
<h2><a name="unacceptable"></a>Unacceptable topics</h2>
<h2><a name="unacceptable"></a>Unacceptable Topics</h2>
<ul>
<li>Advertisements for commercial products.</li>
<li>Requests for help getting non-boost code to compile with your compiler.
@ -137,7 +138,7 @@ probably have the wrong subject line. Instead, you can reply through
the <a href="http://news.gmane.org/gmane.comp.lib.boost.devel">GMane
web interface</a>.
<h2><a name="behavior"></a>Prohibited behavior</h2>
<h2><a name="behavior"></a>Prohibited Behavior</h2>
<p>Prohibited behavior will not be tolerated. The moderators will ban
postings by abusers.</p>
<h3>Flame wars</h3>
@ -171,7 +172,7 @@ as proper capitalization. Avoid copious informalism, colloquial
language, or abbreviations, they may not be understood by all readers.
Re-read your message before submitting it.</p>
<h2>Guidelines for effective discussions</h2>
<h2>Guidelines for Effective Discussions</h2>
<p>Apply social engineering to prevent heated technical discussion from
degenerating into a shouting match, and to actively encourage the cooperation
upon which Boost depends.</p>
@ -202,11 +203,39 @@ among experts few felt comfortable with the issues. Endless days were then
spent discussing where to put the bicycle shed (the parking lot would
be a modern equivalent) because everyone
understood the issues and felt comfortable discussing them.&nbsp;</p>
<hr>
<p>Revised <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->02 October, 2003<!--webbot bot="Timestamp" i-checksum="38549" endspan -->
</p>
<p>© Beman Dawes 2000</p>
<h2><a name="lib_names"></a>Library Names</h2>
<p>In order to ensure a uniform presentation in books and articles, we
have adopted a convention for referring to Boost libraries. Library
names can either be written in a compact form with a dot, as
&quot;Boost.<i>Name</i>&quot;, or in a long form as &quot;the
Boost <i>Name</i> library.&quot; For example:
<blockquote>
<b>Boost.Python</b> serves a very different purpose from <b>the Boost Graph library</b>.
</blockquote>
Note that the word &quot;library&quot; is not part of the name, and as such isn't capitalized.
<p>Please take care to avoid confusion in discussions between
libraries that have been accepted into Boost and those that have not.
Acceptance as a Boost library indicates that the code and design have
passed through our peer-review process; failing to make the
distinction devalues the hard work of library authors who've gone
through that process. Here are some suggested ways to describe
potential Boost libraries:
<ul>
<li>the proposed Boost <i>Name</i> library</li>
<li>the Boost.<i>Name</i> candidate</li>
<li>the <i>Name</i> library</i> (probably the best choice where applicable)</li>
</ul>
<p>Note that this policy only applies to discussions, not to the
documentation, directory structure, or even identifiers in the
code of potential Boost libraries.
<hr>
<p>Revised <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->24 March, 2005<!--webbot bot="Timestamp" i-checksum="38549" endspan -->
</p>
<p>© Beman Dawes, Rob Stewart, and David Abrahams 2000-2005</p>
<p> Distributed under 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>)