Coding standards draft

[ZivIzhar]

Please read and give feedback if you think it's needed. (that's just a draft for now) I probably missed some stuff, so please comment anything else you think we should include in here.

Environment

• Latest JDK8
• Latest Eclipse
• Latest Spartanizer plugin

Spartanizer

we should decide about this part since it'll take some effort to fix that Disable the followings:

• Dollarizations
• Centification
• In-lining

Code

• The Spartanizer forces our code in most cases, therefore, there are few things to remeber.
  • Do not exceed 80 characters in a line. Breaking lines will be as described in here Line Wraping
  • Naming - Variables and Function names should be named in camelCase
  • Curly Brackets
  • In if and for's, use the following style (it's java here, not c#)

    if (true) {
    statements;
    }

  • Do not use curly brackets when you don't need to, for example:

    if (true)
    statement;

• Identation - use only tabs
• When you are not sure what style you should write in - be consistent with the current file/package.

Documentation

• Explain any non-trivial code
• Explain any function
• Include @author and @since in every class you create

Before commiting:

Make sure:

• There are no errors
• There are no warnings
• The tests pass locally

While commiting:

• Make sure your commit comment explains clearly what the commit is about
• Remember to include the issue number in the comment
• we should consider start using prefixes in the commit comments, for example "[DB] update the database code"

After commiting:

• You should check travis to make sure you didn't break the project

[mdoron]

In-lining ?

[ZivIzhar]

Posted as a wiki page, open the issue if discussion is needed.