couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "Coding Standards" by JanLehnardt
Date Sat, 22 Aug 2009 08:41:17 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.

The following page has been changed by JanLehnardt:
http://wiki.apache.org/couchdb/Coding_Standards

The comment on the change is:
move coding standards from website to wiki

New page:
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 trailing spaces and newlines in your files. Good editors usually have a configuration
option that prevents this from happening.
 * 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 [http://www.erlang.se/doc/programming_rules.shtml
Erlang Programming Rules and Conventions].

Mime
View raw message