Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1.42 KB

versioned_releases.md

File metadata and controls

21 lines (14 loc) · 1.42 KB

Software Must Be Versioned

This is one of the tier 1 standards. See full list on the main page.

Short description

As software is incrementally released, it is common practice to give unique version names or numbers to the newly released code.

Importance of this standard

Attaching version numbers to software releases allow for users, especially less technical users, to easily keep track of changes and determine if an upgrade is needed.

Options for this standard

As it is ITSD policy is to host your software in a GitHub or GitLab repository, we suggest using GitHub or GitLab tags respectively for versioning your software.

When naming these versions, we suggest you follow the STScI style guide's recommendation of Semantic Versioning. See the style guide's description of this system for more information. While this is the suggested method, the most important thing is to be consistent and document your versioning method for users.

How to apply this standard

See these how-to articles for creating:

See the SemVer website and their FAQ section for details on using their versioning convention.