Software Development Guidelines

From GreenVulcano Wiki
Revision as of 10:16, 3 January 2016 by D.barra (talk | contribs) (Rationale written)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Rationale

The GreenVulcano code base has been growing over time. While the code has traditionally been "reviewed" by one or two people (our historical "good dictators") before submission to public availability, this is becoming less and less the case due to our increasing core development community. Therefore, some self-discipline is needed in order to improve collaboration - and, sometimes, reduce the frustration due to switching from one style to the other between different source files (and often even within the same file).

This is an open, ongoing, collaborative document! If you feel like a new guideline is needed for the project, then:

  • Discuss it with senior colleagues to check that it actually makes sense, then
  • Add it to this document, in the relevant section.

Design

Naming

Formatting

Versioning