You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by cm...@apache.org on 2008/06/03 21:12:23 UTC
svn commit: r662860 - in /incubator/couchdb/site/htdocs/community:
lists.html standards.html standards.txt
Author: cmlenz
Date: Tue Jun 3 12:12:23 2008
New Revision: 662860
URL: http://svn.apache.org/viewvc?rev=662860&view=rev
Log:
site: Added minimal set of basic coding standards.
Modified:
incubator/couchdb/site/htdocs/community/lists.html
incubator/couchdb/site/htdocs/community/standards.html
incubator/couchdb/site/htdocs/community/standards.txt
Modified: incubator/couchdb/site/htdocs/community/lists.html
URL: http://svn.apache.org/viewvc/incubator/couchdb/site/htdocs/community/lists.html?rev=662860&r1=662859&r2=662860&view=diff
==============================================================================
--- incubator/couchdb/site/htdocs/community/lists.html (original)
+++ incubator/couchdb/site/htdocs/community/lists.html Tue Jun 3 12:12:23 2008
@@ -86,11 +86,11 @@
<ul>
<li>To <strong>subscribe</strong>, send an email to
-<a href="mailto:couchdb-user-subscribe@incubator.apache.org">couchdb-user-subscribe@incubator.apache.org</a>.</li>
+<a href="mailto:couchdb-user-subscribe@incubator.apache.org">couchdb-user-subscribe@incubator.apache.org</a>.</li>
<li>To <strong>unsubscribe</strong> send empty email to
-<a href="mailto:couchdb-user-unsubscribe@incubator.apache.org">couchdb-user-unsubscribe@incubator.apache.org</a></li>
+<a href="mailto:couchdb-user-unsubscribe@incubator.apache.org">couchdb-user-unsubscribe@incubator.apache.org</a></li>
<li>Finally, to post a message to the list use the address
-<a href="mailto:couchdb-user@incubator.apache.org">couchdb-user@incubator.apache.org</a></li>
+<a href="mailto:couchdb-user@incubator.apache.org">couchdb-user@incubator.apache.org</a></li>
</ul>
<p>The archives for this list can also be <a href="http://mail-archives.apache.org/mod_mbox/incubator-couchdb-user/">browsed online</a>.</p>
@@ -105,11 +105,11 @@
<ul>
<li>To <strong>subscribe</strong>, send an email to
-<a href="mailto:couchdb-dev-subscribe@incubator.apache.org">couchdb-dev-subscribe@incubator.apache.org</a>.</li>
+<a href="mailto:couchdb-dev-subscribe@incubator.apache.org">couchdb-dev-subscribe@incubator.apache.org</a>.</li>
<li>To <strong>unsubscribe</strong> send empty email to
-<a href="mailto:couchdb-dev-unsubscribe@incubator.apache.org">couchdb-dev-unsubscribe@incubator.apache.org</a></li>
+<a href="mailto:couchdb-dev-unsubscribe@incubator.apache.org">couchdb-dev-unsubscribe@incubator.apache.org</a></li>
<li>Finally, to post a message to the list use the address
-<a href="mailto:couchdb-dev@incubator.apache.org">couchdb-dev@incubator.apache.org</a></li>
+<a href="mailto:couchdb-dev@incubator.apache.org">couchdb-dev@incubator.apache.org</a></li>
</ul>
<p>The archives for this list can also be <a href="http://mail-archives.apache.org/mod_mbox/incubator-couchdb-dev/">browsed online</a>.</p>
@@ -122,9 +122,9 @@
<ul>
<li>To <strong>subscribe</strong>, send an email to
-<a href="mailto:couchdb-commits-subscribe@incubator.apache.org">couchdb-commits-subscribe@incubator.apache.org</a>.</li>
+<a href="mailto:couchdb-commits-subscribe@incubator.apache.org">couchdb-commits-subscribe@incubator.apache.org</a>.</li>
<li>To <strong>unsubscribe</strong> send empty email to
-<a href="mailto:couchdb-commits-unsubscribe@incubator.apache.org">couchdb-commits-unsubscribe@incubator.apache.org</a></li>
+<a href="mailto:couchdb-commits-unsubscribe@incubator.apache.org">couchdb-commits-unsubscribe@incubator.apache.org</a></li>
</ul>
<p>Replies to commit mails should be directed to the <code>couchdb-dev</code> mailing list.</p>
Modified: incubator/couchdb/site/htdocs/community/standards.html
URL: http://svn.apache.org/viewvc/incubator/couchdb/site/htdocs/community/standards.html?rev=662860&r1=662859&r2=662860&view=diff
==============================================================================
--- incubator/couchdb/site/htdocs/community/standards.html (original)
+++ incubator/couchdb/site/htdocs/community/standards.html Tue Jun 3 12:12:23 2008
@@ -69,6 +69,28 @@
</ul>
</div>
<div id="content"><h1>Coding Standards</h1>
+
+<p>CouchDB comes with code in a variety of different languages. While the core is
+written in Erlang, there are some parts written in C, others written in HTML,
+CSS, and Javascript, and then there are also shell scripts, Makefiles, et
+cetera.</p>
+
+<p>First, some general rules:</p>
+
+<ul>
+<li>Always use spaces for indentation, not tabs, except in Makefiles.</li>
+<li>Use four spaces for indentation in Erlang and C code, two spaces in HTML,
+CSS, and Javascript.</li>
+<li>Try to keep lines shorter than 80 characters.</li>
+<li>When you edit a file, try to stick with the conventions used in the
+surrounding code.</li>
+<li>Avoid mixing purely cosmetic changes (such as removing trailing white-space)
+with functional changes, as that makes review of the actual change (whether
+it’s a check-in or a patch) much more difficult.</li>
+</ul>
+
+<p>For more detailed coding conventions for Erlang code, please see the <a href="http://www.erlang.se/doc/programming_rules.shtml">Erlang
+Programming Rules and Conventions</a>.</p>
<div id="clear"></div></div>
</div></div>
<div id="footer">
Modified: incubator/couchdb/site/htdocs/community/standards.txt
URL: http://svn.apache.org/viewvc/incubator/couchdb/site/htdocs/community/standards.txt?rev=662860&r1=662859&r2=662860&view=diff
==============================================================================
--- incubator/couchdb/site/htdocs/community/standards.txt (original)
+++ incubator/couchdb/site/htdocs/community/standards.txt Tue Jun 3 12:12:23 2008
@@ -4,3 +4,23 @@
%(title)s
=========
+
+CouchDB comes with code in a variety of different languages. While the core is
+written in Erlang, there are some parts written in C, others written in HTML,
+CSS, and Javascript, and then there are also shell scripts, Makefiles, et
+cetera.
+
+First, some general rules:
+
+ * Always use spaces for indentation, not tabs, except in Makefiles.
+ * Use four spaces for indentation in Erlang and C code, two spaces in HTML,
+ CSS, and Javascript.
+ * Try to keep lines shorter than 80 characters.
+ * When you edit a file, try to stick with the conventions used in the
+ surrounding code.
+ * Avoid mixing purely cosmetic changes (such as removing trailing white-space)
+ with functional changes, as that makes review of the actual change (whether
+ it's a check-in or a patch) much more difficult.
+
+For more detailed coding conventions for Erlang code, please see the [Erlang
+Programming Rules and Conventions](http://www.erlang.se/doc/programming_rules.shtml).