(Draft) Coding conventions

/!\ THESE CONVENTIONS ARE NOT OFFICIAL IN ANY WAY. PLEASE IGNORE THEM FOR NOW /!\

The conventions are marked with the following symbols

Symbol

Meaning

{1}

Must have convention. A failure to comply with the requirement may lead to the rejection of a patch

{2}

Should have convention. Recommended but not mandatory

{3}

Unapproved convention. Use when adding a new convention before it is officially signed off. Developers please ignore these conventions for now

Eclipse IDE

If you are using the Eclipse IDE for development, then it is recommended to download the following:

Style

Javadoc & comments

Fields

Constructors

Exceptions

Collections

JIRA integration

General

Annotations

TODO use of jcip annotations like ThreadSafe etc.

CodingConventions (last edited 2013-01-06 12:00:59 by stian)