Version Numbering

By bf-scottbf-scott, on 08 Feb 2013 09:09

For version numbering scheme, use this:

ProjectName_[major 0].[minor 0]-[unstable/rc, stable].[Archive Ext (.zip)]

Minor versions are assigned to source code that is in a draft (unstable or rc (Release Candidate)) status. Any time a change is made to the source code the Minor version is incremented. If source code is released as Stable, it will increment to the next Major version. For example, if you release version 3.51 to Stable, it becomes version 4.0.

The version of the .ino (Sketch) file will be maintained in the source code in a commented header.

Example Sketch Header:

//Bigfoot Studios, Inc.
//Arduino Lab Team Project: Guard Monitor
//Sketch Version: 1.12-rc
//Compatible with the Arduino IDE 1.x

Note: .zip file to include .ino file and all required libraries. Include any relevant .doc files required for configuring devices for running code (otherwise, refer to this wiki site).

For best practice, maintain a stable and an unstable (rc build) version in parallel and when the unstable one hits stable, start on the next unstable. This gives users the choice between boring stability and exciting crashfulness.

To reflect the rc/stable parallel files - for source code in working progress - include in the Source Code section on the wiki pages. For example:

Source Code

Name Modified Author
GuardMonitor_1.12-rc 02/20/2013 Joe
GuardMonitor_1.0-stable 02/18/2013 Joe

Note: When inserting sample source code into the wiki docs, use the Code Block Wizard to specify source code formatting as C++ (ex. [[code type="Cpp"]]).

Add a New Comment