Guidelines

This document proceeds to explain some standards that should be kept to make the code easily understandable and maintainable

Code

• For the purpose of structure, classes should be reasonably divided into packages.
• The classes should be easy to read, and some level of documentation is helpful. It is not necessary to comment every single line, but the key properties/methods of the classes should have some javadoc. See How can I write javadoc in eclipse

Tests with JUnit

• To ensure stability and ease of debugging, we will use JUnit to write unit tests. The JUnit library is included with the code, contained in the lib folder.

• The point of writing unit tests is to ensure the implemented features are working as intended. PROTIP: write the tests before you implement the feature! Why? See TDD - Test driven development.

• For information on how to use JUnit, see JUnit homepage