dion 02/01/29 18:55:59
Modified: latka/doc developers-guide.xml status.xml
Log:
Added more info on general practices, updated todos in status
Revision Changes Path
1.5 +22 -3 jakarta-commons/latka/doc/developers-guide.xml
Index: developers-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/latka/doc/developers-guide.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- developers-guide.xml 30 Jan 2002 02:39:51 -0000 1.4
+++ developers-guide.xml 30 Jan 2002 02:55:59 -0000 1.5
@@ -4,13 +4,13 @@
<!--
Author: dIon Gillard
- Version: $Id: developers-guide.xml,v 1.4 2002/01/30 02:39:51 dion Exp $
+ Version: $Id: developers-guide.xml,v 1.5 2002/01/30 02:55:59 dion Exp $
-->
<chapter id="users-guide">
<title>Latka Developers's Guide</title>
- <section>
+ <section id="introduction">
<title>Introduction</title>
<para>These are informal notes gathered as I've started working
on <ulink url="index.html">Latka</ulink>. Hopefully they will make sense to
@@ -20,7 +20,7 @@
like a book than a chapter</para>
<para>That said, on with the disorganised discourse</para>
</section>
- <section>
+ <section id="coding-style">
<title>Coding Style</title>
<para>Latka has some unusual coding conventions, which I'm trying to
@@ -41,6 +41,25 @@
</itemizedlist>
</section>
+ <section id="general-practices">
+ <title>General Practices</title>
+
+ <para>Here are some of the development practices of the Latka team</para>
+
+ <itemizedlist>
+ <listitem><para>Before committing any changes, run a cvs diff to
+ensure unexpected changes are not being introduced</para>
+ </listitem>
+ <listitem><para>Before committing java source code changes, do a
+clean build of the project to ensure all code still compiles. Run all testcases
+to ensure the code isn't broken. Run the checkstyle task to ensure code meets
+the project's current standards</para>
+ </listitem>
+ <listitem><para>Before committing changes to the web pages, do a
+clean build of the webpages target in the main build file and view the resulting
+output</para></listitem>
+ </itemizedlist>
+ </section>
<!-- other sections: build files, documentation, updating the live site,
explaining the dtds, directory structure of source, what we need
help with, docbook, the xsl stylesheets
1.8 +14 -2 jakarta-commons/latka/doc/status.xml
Index: status.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/latka/doc/status.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- status.xml 27 Jan 2002 20:44:27 -0000 1.7
+++ status.xml 30 Jan 2002 02:55:59 -0000 1.8
@@ -7,7 +7,8 @@
Author: Morgan Delagrange
Author: Doug Sale
Author: Rodney Waldhoff
- Version: $Id: status.xml,v 1.7 2002/01/27 20:44:27 dion Exp $
+ Author: dIon Gillard
+ Version: $Id: status.xml,v 1.8 2002/01/30 02:55:59 dion Exp $
-->
<chapter id="status">
@@ -22,6 +23,9 @@
<author><firstname>Rodney</firstname><surname>Waldhoff</surname>
<affiliation><address><email>[EMAIL PROTECTED]</email></address></affiliation>
</author>
+ <author><firstname>dIon</firstname><surname>Gillard</surname>
+
<affiliation><address><email>[EMAIL PROTECTED]</email></address></affiliation>
+ </author>
</authorgroup>
</chapterinfo>
@@ -63,7 +67,8 @@
<section>
<title>3. RELEASE INFO</title>
- <para>Current Release: <ulink
url="http://jakarta.apache.org/builds/jakarta-commons/release/commons-latka/1.0/";>
+ <para>Current Release: <ulink
+url="http://jakarta.apache.org/builds/jakarta-commons/release/commons-latka/1.0/";>
1.0 alpha 1</ulink></para>
<para>Planned Next Release: 1.0, timeframe: None defined</para>
</section>
@@ -113,6 +118,13 @@
optional at build time.</para></listitem>
<listitem><para>Write unit tests for each validator, with a mock
object implementing the Response interface</para></listitem>
+ <listitem><para>Create better documentation, especially the
+<ulink url="users-guide.html">User's Guide</ulink> and
+<ulink url="developers-guide.html">Developer's Guide</ulink></para></listitem>
+ <listitem><para>Ensure coding standards are consistent across
+the project's codebase, preferably using a tool such as
+<ulink url="http://checkstyle.sourceforge.net/";>CheckStyle</ulink></para>
+ </listitem>
</itemizedlist>
</section>
</section>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
