Author: rdonkin
Date: Thu May 14 16:17:45 2009
New Revision: 774838
URL: http://svn.apache.org/viewvc?rev=774838&view=rev
Log:
Consolidate coding standards into contribution
Removed:
james/project/trunk/project/src/site/xdoc/code-standards.xml
Modified:
james/project/trunk/project/src/site/site.xml
james/project/trunk/project/src/site/xdoc/contribute.xml
Modified: james/project/trunk/project/src/site/site.xml
URL:
http://svn.apache.org/viewvc/james/project/trunk/project/src/site/site.xml?rev=774838&r1=774837&r2=774838&view=diff
==============================================================================
--- james/project/trunk/project/src/site/site.xml (original)
+++ james/project/trunk/project/src/site/site.xml Thu May 14 16:17:45 2009
@@ -57,7 +57,6 @@
<item name="Wiki" href="http://wiki.apache.org/james"; />
<item name="Who We Are" href="/weare.html" />
<item name="Contributing" href="/contribute.html" />
- <item name="Standards" href="/code-standards.html" />
<item name="License" href="/license.html" />
</menu>
Modified: james/project/trunk/project/src/site/xdoc/contribute.xml
URL:
http://svn.apache.org/viewvc/james/project/trunk/project/src/site/xdoc/contribute.xml?rev=774838&r1=774837&r2=774838&view=diff
==============================================================================
--- james/project/trunk/project/src/site/xdoc/contribute.xml (original)
+++ james/project/trunk/project/src/site/xdoc/contribute.xml Thu May 14
16:17:45 2009
@@ -106,6 +106,73 @@
happy to receive good documentation.
</p>
</section>
+
+ <section name="Coding Standards">
+
+ <p>
+ Submissions to the James project must follow the coding conventions
+ outlined in this document. James developers
+ are asked to follow coding conventions already present in the code.
+ (For example, if the existing code has the bracket on
+ the same line as the if statement, then all subsequent code
+ should also follow that convention.) Anything not
+ explicitly mentioned in this document should adhere to the
+ official
+ <a
href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html";>Sun
+ Java Coding Conventions</a>.
+ </p>
+
+ <p>
+ <strong>Developers who commit code that does not follow
+ the coding conventions outlined in this document will be
+ responsible for fixing their own code.</strong>
+ </p>
+
+ <p>
+ 1. Spaces between parentheses are optional. The preference is to
exclude
+ extra spaces. Both of these conventions are acceptable:
+ </p>
+
+ <p>
+ <source><![CDATA[
+
+ if (foo)
+
+ or
+
+ if ( foo )
+ ]]></source>
+ </p>
+
+ <p>
+ 2. Four spaces. <strong>NO tabs</strong>. Period. The James
+ mailing list receives commit messages that are almost impossible
+ to read if tabs are used.
+ </p>
+
+ <p>
+ In Emacs-speak, this translates to the following command:
+
+ (setq-default tab-width 4 indent-tabs-mode nil)
+ </p>
+
+ <p>
+ 3. Use Unix linefeeds for all .java source code files. Only
platform-specific
+ files (e.g. .bat files for Windows) should contain non-Unix linefeeds.
+ </p>
+
+ <p>
+ 4. Javadoc <strong>must</strong> exist on all methods. Contributing
+ a missing javadoc for any method, class, variable, etc., will be
GREATLY
+ appreciated as this will help to improve the James project.
+ </p>
+
+ <p>
+ 5. The standard Apache boilerplace <strong>MUST</strong> be placed
+ at the top of every file.
+ </p>
+
+ </section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
