Versioning: Difference between revisions

Revision as of 22:16, 23 September 2019

Versioning practice at OSE follows the naming convention of naming the module under development followed by v for version and date. Example:

3D_Printer_v19.10

This refers to the 3D Printer, the version whose start build date was October of 2019.

Notes:

Use a version at every level - Machine, module, or submodule/part. Note that these different levels of detail are all considered as modules when referring to the development process: you can be developing the final product at the machine level, at the module level, or sub/part level. Each of these modules should have a version.
Use official naming convention of modules from GVCS Modules List.
In name, use capital letters for all first letters of words in the name. Thus, it's 3D Printer, not 3D printer.
Use v in small letters, which is short for version
Since we go through multiple prototypes over multiple years - start with the year in the version name.
Use month for the month the projects was STARTED. Since documentation is realtime and you don't know when the version development will end - it makes sense to use the month started.
If multiple versions are iterated in the same month, name the latter one with the DAY it was started, such as v19.10.22 (for starting on October 22)

@@ Line 7: / Line 7: @@
 Notes:
+#Use a version at every level - Machine, module, or submodule/part. Note that these different levels of detail are all considered as modules when referring to the development process: you can be developing the final product at the machine level, at the module level, or sub/part level.  Each of these modules should have a version.
 #Use official naming convention of modules from [[GVCS Modules List]].
 #In name, use capital letters for all first letters of words in the name. Thus, it's 3D Printer, not 3D printer.