[cvs] expresso commit by mtraum: added coding conventions
JCorporate Ltd
jcorp at jcorp2.servlets.net
Fri Oct 22 10:01:17 PDT 2004
Log Message:
-----------
added coding conventions
Modified Files:
--------------
expresso/expresso-web/expresso/doc/edg:
contrib.xml
Revision Data
-------------
Index: contrib.xml
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/expresso/doc/edg/contrib.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -Lexpresso-web/expresso/doc/edg/contrib.xml -Lexpresso-web/expresso/doc/edg/contrib.xml -u -r1.12 -r1.13
--- expresso-web/expresso/doc/edg/contrib.xml
+++ expresso-web/expresso/doc/edg/contrib.xml
@@ -1,6 +1,35 @@
<appendix id='editedg' xreflabel='Contribute's Guide'>
<title>Contributing To Expresso Framework</title>
<sect1>
+ <title>Coding Conventions and Guidelines</title>
+ <para>
+
+Source code contributed to Expresso should follow certain guidelines. Contributors
+should follow the <ulink url='http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html'>Sun
+Java Coding Conventions</ulink>, except fot the following exceptions and
+clarifications:
+ <orderedlist>
+ <listitem>
+ <para>License</para>
+ <para>
+The Jcorporate Apache Style Software License must be placed at the top
+of each java source file.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Indentation</para>
+ <para>
+Four spaces (no tabs) should be used for indentation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Line Length</para>
+ <para>Avoid lines longer than 120 characters.</para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </sect1>
+ <sect1>
<title>Editing The Expresso Developers Guide</title>
<sect2>
<title>DocBook, XML, and XSLT</title>
More information about the cvs
mailing list