Guidelines

Jump to bottom Edit New page

Christoph Lange edited this page Feb 5, 2014 · 1 revision

Naming Conventions in Java

Packages should have the following prefix de.unibonn.iai.eis.<project_name>. For example de.unibonn.iai.eis.diachron
For packages within a project, interface and implemented classes should be separated. Quality metric interfaces are found in de.unibonn.iai.eis.diachron.qualitymetrics. Implemented metrics should be placed under their dimension. For example the metric RDF Accessibility is defined within the "Availability" dimensions under the "Accessibility" dimension group. Therefore the right way to define the package is de.unibonn.iai.eis.diachron.qualitymetrics.accessibility.availability.

Java Classes

Make use of JavaDoc comments for all methods and classes

Test Classes

For each implemented class, a corresponding test class should be created. This should extend the JUnit test suite (extends Assert).
Make sure that all tests pass and there is no hard-coded paths. Jenkins will haunt you during the night.

Using GitHub

It is encouraged to do small commits with appropriate messages on every modified file, and push once
It is important to push code to the Git repository if all tests pass. Please do not push untested code and/or code with errors.