j8unit-team/developer

Conventions for J8Unit Committers

J8Unit :: Developer Settings

Hi there,

if you want to support the j8unit team you should be aware of the code styles, conventions and formatter rules.

In order to keep the code consistent, to prevent encoding problems, to understand new code more quickly and thoroughly, to avoid arguing over syntax, naming standards, and style preferences we must insist on consistent code.

Avowedly, good style is a subjective matter and the perception of beauty is subjective. However, these are the rules which we think are fine for us:

Eclipse (Oxygen)

• Window -> Preference -> General -> Editors -> Structured Text Editors -> Task Tags
  • Settings according to J8Unit Task Tags
• Window -> Preference -> General -> Workspace
  • Settings according to J8Unit Workspace Settings
• Window -> Preference -> Java -> Code Style -> Clean Up
  • Import the J8Unit Clean-Up Profile
• Window -> Preference -> Java -> Code Style -> Formatter
  • Import the J8Unit Code Formatter Profile
• Window -> Preference -> Java -> Code Style -> Organize Imports
  • Import the J8Unit Import Order
• Window -> Preference -> Java -> Editor -> Save Actions
  • Settings according to J8Unit Save Actions
• Window -> Preference -> XML -> XML Files -> Editor
  • Settings according to J8Unit Save Actions

Maven

Preliminarily, Maven runs much smarter with Maven Bash Auto Completion.

Further, we (most of the time) respect the Maven's convention over configuration concept. In particular, we use the Standard Directory Layout.