Development environment set up

---

Feel free to change instructions and rules here. This is only draft version.

IDE

Set up your IDE as the following:

• use spaces for tabs
• set up auto code formatting (you can skip this after reading and following this or this)

Code Quality

Set up code quality checking tools:

• PMD

  • Usually we use a maven plugin
  • Set up plugin to use pmd rules file from this repository

• Checkstyle

  • Maven plugin
  • Set up plugin to use rules file from this repository

• FindBugs

  • Maven plugin
  • Set up plugin to use rules file from this repository

Once you've set this all up, run:

mvn site

Before pushing to remote repository:

• Make sure that your code passes all pmd, findbugs and checkstyle checks
• Code is covered with unit tests
• Code review is passed