Project

General

Profile

Actions

Guidelines » History » Revision 14

« Previous | Revision 14/24 (diff) | Next »
Greg Burri, 08/01/2009 08:32 PM


Guidelines

Documentation

  • Use of ' when referencing a name like 'myVar'
  • Use of " when referencing a value like "my string"

Coding

See the prototypes for code reference : source:/prototypes.

Some random rules

  • Try to minimize the use of dynamic allocation. Use constructor initializer to set non-pointer members.
  • Use parameter references variable passing instead of pointers.
  • Always have the design pattern RAII in mind.

Version number

A version number has three numbers plus a tag and some other information :
<a>.<b>.<c> <tag> <date+time> <tree hash>

<a> : Major version
<b> : Evolution
<c> : Revision (bugfixes)
<tag> : alpha | beta | <nothing>
<date+time> : Date and time of the built tree, for example : 2009-08-01 17:42Z. See ISO8601
<tree hash> : The hash of the built tree, for example : fd9d9d0117ef1845368da790085617ab61bc5051

For example (date, time and hash are omitted) :
  • 1.0 alpha (first version)
  • 1.0 beta
  • 1.0 (stable version)
  • 1.0.1 (first revision)
  • 1.0.2 (second revision)
  • 1.1 alpha (first evolution)
  • 1.1 beta
  • 1.1
  • 1.1.1
  • etc..

Beta and alpha versions

The alpha is a development version not yet finished only for developers.
The beta is an almost released version that can be public.

Updated by Greg Burri over 14 years ago · 14 revisions