This document describes a list of coding conventions that are required for code submissions to the project. By default, the coding conventions for most Open Source Projects should follow the existing coding conventions in the code that you are working on. For example, if the bracket is on the same line as the if statement, then you should write all your code to have that convention.

Below is a list of coding conventions that are specific to Mevenide.

If you commit code that does not follow these conventions, you are responsible for also fixing your own code.

Coding Rules

  1. Remove unused Imports
  2. Use fully qualified Imports
  3. Brackets on the same line
  4. Always use brackets
  5. Use explicit naming
  6. Methods should kept very short
  7. Remove unneeded javadoc
  8. Always provide class javadoc
  9. Use 4 spaces for tabs