Versioning: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 7: | Line 7: | ||
Notes: | Notes: | ||
#Use a unique name for everything. For example, 3D Printer v19.10 - is not the same as 3D Printer v18.09. | |||
#When a new version is created, add that version to the list at the [[Genealogies]] page. | |||
#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 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. | ||
#When developing at the Module level, include the full name that identifies the largest unit of organization: for example: use 3D Printer Extruder v19.10, not Extruder v19.10. Same for part - use the 3D Printer Extruder Nozzle v19.10, not Nozzle v19.10. | #When developing at the Module level, include the full name that identifies the largest unit of organization: for example: use 3D Printer Extruder v19.10, not Extruder v19.10. Same for part - use the 3D Printer Extruder Nozzle v19.10, not Nozzle v19.10. |
Revision as of 22:20, 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 unique name for everything. For example, 3D Printer v19.10 - is not the same as 3D Printer v18.09.
- When a new version is created, add that version to the list at the Genealogies page.
- 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.
- When developing at the Module level, include the full name that identifies the largest unit of organization: for example: use 3D Printer Extruder v19.10, not Extruder v19.10. Same for part - use the 3D Printer Extruder Nozzle v19.10, not Nozzle v19.10.
- 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)