HACKING

A Checkstyle configuration is provided in the root folder. Use this configuration whenever possible. Moreover the contained Eclipse project's auto formatter is adapted to fit this configuration. Use this, too.

To execute checkstyle you can use ant checkstyle.

The general coding guidelines are:

• Use spaced instead of tabs.
• General indentation depth is 4 spaces.
• Everything except case-statements is indented.
• Curly braces are placed in the same line as the statement.
• Place one space between control statements and the opening brace (e.g. for (foo)).
• Comment everything that is not a private variable with a valid javadoc comment. Use ant doc to verify that the comments are valid.
• Every non final static variable must be private and encapsulated with getters and setters.
• If Checkstyle warns and this warning is really not an issue, include the lines that contain the warning in
  // CHECKSTYLE:OFF why this is not an issue
LINES LINES LINES
// CHECKSTYLE:ON

Unit Testing

The new BonSAI-core has a lot of more unit tests than the old one. The unit tests can be executed with ant test. Please write unit tests whenever possible. If Cobertura is installed at your system, you can also use ant coverage to run the unit tests and generate a code coverage report. The report will be located under reports.