Revision: 1829
Author: [email protected]
Date: Mon Feb 1 02:01:25 2010
Log: Some style and typos for DevelopSimal doc.
http://code.google.com/p/simal/source/detail?r=1829
Modified:
/wiki/DevelopSimal.wiki
=======================================
--- /wiki/DevelopSimal.wiki Mon Feb 1 01:58:14 2010
+++ /wiki/DevelopSimal.wiki Mon Feb 1 02:01:25 2010
@@ -53,8 +53,7 @@
We use a Subversion repository for our source code, therefore you need
an SVN plugin like Subclipse for working with the repository. You can
install
-the Subclipse plugin in Eclipse using their update site
[http://subclipse.tigris.org/update_1.6.x";>
-http://subclipse.tigris.org/update_1.6.x] in the Eclipse Update Manager.
If you are unfamiliar
+the Subclipse plugin in Eclipse using their update site
[http://subclipse.tigris.org/update_1.6.x
http://subclipse.tigris.org/update_1.6.x] in the Eclipse Update Manager. If
you are unfamiliar
with the Eclipse update manager you can find a good tutorial
[http://www.vogella.de/articles/Eclipse/article.html#plugin_installation
here]
@@ -84,7 +83,7 @@
The first thing you need to do is checkout the Simal source code. To do
this
use the
[http://simal.googlecode.com/svn/wiki/DevelopSimal.attach/simal.psf
simal.psf] team set.
- * Save the
[http://simal.googlecode.com/svn/wiki/DevelopSimal.attach/simal.psf";>simal.psf]
+ * Save the
[http://simal.googlecode.com/svn/wiki/DevelopSimal.attach/simal.psf
simal.psf]
file in a convenient location
* In Eclipse select {{{File -> Import}}}
@@ -107,61 +106,40 @@
some tests:
- * right click on {{{uk.ac.osswatch.simal.core/src/test/java}}}
-and select {{{Run As -> JUnit Test}}}
-
- * Wait for the tests to run, you should get a green bar for all
-tests
-
- * right click on {{{uk.ac.osswatch.simal.rest/src/test/java}}}
-and select {{{Run As -> JUnit Test}}}
-
- * Wait for the tests to run, you should get a green bar for all
-tests
-
- * right click on {{{uk.ac.osswatch.simal.web/src/test/java}}}
-and select {{{Run As -> JUnit Test}}}
-
- * Wait for the tests to run, you should get a green bar for all
-tests
-
-
-
-
-===Optional Steps===
-
+ * right click on {{{uk.ac.osswatch.simal.core/src/test/java}}} and select
{{{Run As -> JUnit Test}}}
+
+ * Wait for the tests to run, you should get a green bar for all tests
+
+ * right click on {{{uk.ac.osswatch.simal.rest/src/test/java}}} and select
{{{Run As -> JUnit Test}}}
+
+ * Wait for the tests to run, you should get a green bar for all tests
+
+ * right click on {{{uk.ac.osswatch.simal.web/src/test/java}}} and select
{{{Run As -> JUnit Test}}}
+
+ * Wait for the tests to run, you should get a green bar for all tests
+
+==Optional Steps==
===Task Management===
-These plugins are useful in tracking and managing
-tasks.
+These plugins are useful in tracking and managing tasks.
===Mylyn Generic Issue Tracker Integration===
-TODO Describe use of the Mylyn generic issue tracker to
-[http://www.jroller.com/alexRuiz/entry/using_mylyn_with_google_code
integrate] with Google
-Code
+TODO Describe use of the Mylyn generic issue tracker to
[http://www.jroller.com/alexRuiz/entry/using_mylyn_with_google_code
integrate] with Google Code
===Code Quality===
-The plugins are used for managing code quality in Simal.
-They typically generate a number of reports indicating
-potential problems with code quality. It is good practice
-to run these reports on a periodic basis and to fix as many
-issues they highlight as is possible.
-
-Many of these plugins integrated with our Maven builds
-and our [http://16degrees.com.au/hudson continuous integration]
-server. This allows us to keep an eye on the quality trends within
-our code.
+The plugins are used for managing code quality in Simal. They typically
generate a number of reports indicating potential problems with code
quality. It is good practice to run these reports on a periodic basis and
to fix as many issues they highlight as is possible.
+
+Many of these plugins integrated with our Maven builds and our
[http://16degrees.com.au/hudson continuous integration] server. This allows
us to keep an eye on the quality trends within our code.
===PMD===
-[http://pmd.sourceforge.net/ PMD] scans Java source code and looks for
-potential problems like:
+[http://pmd.sourceforge.net/ PMD] scans Java source code and looks for
potential problems like:
* Possible bugs - empty try/catch/finally/switch statements
@@ -171,18 +149,14 @@
* Duplicate code - copied/pasted code means copied/pasted bugs
-Use the [http://pmd.sourceforge.net/eclipse/ PMD Eclipse update]
-site to install this plugin.
+Use the [http://pmd.sourceforge.net/eclipse/ PMD Eclipse update] site to
install this plugin.
-
-===FindBugs===
-
-[http://findbugs.sourceforge.net/ FindBugs] uses static analysis to look
for
-bugs in Java code.
-
-Use the [http://findbugs.cs.umd.edu/eclipse/ FindBugs Eclipse update]
-site to install this plugin.
+===Find bugs===
+
+[http://findbugs.sourceforge.net/ FindBugs] uses static analysis to look
for bugs in Java code.
+
+Use the [http://findbugs.cs.umd.edu/eclipse/ FindBugs Eclipse update] site
to install this plugin.
--
You received this message because you are subscribed to the Google Groups "Simal
Commits" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/simal-commits?hl=en.
