Table of Contents

• Prerequisites
• 2.0 Installation
• 2.1 Run Ant to Install Required ibraries and Compile
• 2.2 Verify installation
• 3.0 Development Guidelines
• 3.1 Discussion Group
• 3.1 Code Style
• 3.2 Unit Testing
• 3.3 Automated Quality Assurance
• Contact

Prerequisites

Ant 1.7.1 and Java 1.6 are required.

2.0 Installation

2.1 Run Ant to Install Required ibraries and Compile

Checkout the source using an SVN client by following these instructions. The source is also available from the downloads section.

From the top level directory, run "ant" which will download Ivy and all dependencies required and also compile the system.

2.2 Verify installation

The source includes an ant based verification process that runs automated quality assurance test. Run the verification by executing the command "ant -f verify.build.xml". The verification process will run JUnit, Checkstyle, PMD, Javadoc, and Findbugs. The verification process will download dependencies as required.

3.0 Development Guidelines

The e-Hoomaluo system was build using the Eclipse IDE. There are several tools we use to aid in development.

3.1 Discussion Group

The e-Hoomaluo discussion group is a good place to start if you wish to provide suggestions, contributions, or comments.

3.1 Code Style

The following Eclipse code formatting configuration file is used to provide consistent code layout.

These are additional coding standards that the project follows: ics613_coding_standard and EJS.

3.2 Unit Testing

If contributing, please write a corresponding unit test for the feature submitted.

3.3 Automated Quality Assurance

Run the automated quality assurance process "ant -f verify.build.xml" prior to committing any code.

Contact

Please send a message to the discussion group if there are any issues or suggestions.