Skip to content

Commit 75bdaa4

Browse files
committed
Adding a VERSION.md file to document how the versioning system should work.
1 parent ff84cb2 commit 75bdaa4

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

VERSION.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Tabby2 Versioning System
2+
3+
This document provides the specification for how the Tabby2 versioning system
4+
should be used.
5+
6+
The purpose of the versioning system is to alert users of the Tabby2 web
7+
application to changes to Tabby2 which they may want to take note of.
8+
9+
### Location of the Version Number
10+
11+
The authority on the Tabby2 version number is specified in the
12+
`utilities/DESCRIPTION` file "Version:" line item.
13+
14+
This is done so that Tabby2 can render its version number in many places from
15+
one single source of authority.
16+
17+
### Changelog
18+
19+
The changelog providing brief descriptions of each version increment is
20+
stored in `utilities/inst/Rmd/changelog.Rmd`.
21+
22+
### Version Format
23+
24+
The format of the Tabby2 version is given by three numbers separated by two
25+
periods, e.g. "Tabby2 Version 2.0.1"
26+
27+
These version numbers are ordered in decreasing significance.
28+
29+
Changes to the first of these version numbers should indicate a major change in
30+
the scope of the project, such as changes in the funding source or
31+
methodological approach.
32+
33+
Changes to the middle of these version numbers should indicate a significant
34+
release, indicating the successful completion of another round of Scientific
35+
Web Tool Clearance at the Centers for Disease Control and Prevention has been
36+
performed for Tabby2.
37+
38+
Changes to the last of these version numbers reflect smaller changes to the
39+
contents of Tabby2 to which the user should be alerted, such as the expansion
40+
and improvement of the underlying model, improvements to the user interface, or
41+
changes which affect the numbers depicted in downloadable outcomes from the
42+
application.

0 commit comments

Comments
 (0)