updated release hierarchy and versioning note

ga4gh · Sep 9, 2020 · 9be2f9b · 9be2f9b
1 parent 093b2de
commit 9be2f9b
Showing 1 changed file with 23 additions and 10 deletions.
diff --git a/docs/source/releases.rst b/docs/source/releases.rst
@@ -4,22 +4,32 @@ Releases
 .. note:: VRS follows `Semantic Versioning 2.0 <http://semver.org/>`_.  For a version
    number MAJOR.MINOR.PATCH:
 
-     * MAJOR version is incremented for incompatible API changes;
-     * MINOR version is incremented for new, backwards-compatible functionality;
-     * PATCH version is incremented for bug fixes.
+     * MAJOR version is incremented for incompatible API changes.
+     * MINOR version is incremented for new, backwards-compatible
+       functionality. For VRS, this means changes that add support for
+       new types of variation or extend existing types.
+     * PATCH version is incremented for bug fixes. For VRS, examples
+       are clarifications of documentation and bug fixes on property
+       constraints.  No changes to information models will occur in
+       PATCH releases.
 
-   The `VRS Roadmap <https://github.com/orgs/ga4gh/projects/5>`__ for
-   upcoming developments.
+   All planned work The `VRS Roadmap
+   <https://github.com/orgs/ga4gh/projects/5>`__ for upcoming
+   developments. All currently planned work will be MINOR updates
+   according to the guidelines above.
 
 
 1.1
 @@@
 
-1.1 is the second release of VRS.
+1.1.0
+#####
+
+1.1.0 is the second release of VRS.
 
 
 New classes
-############
+$$$$$$$$$$$
 
   * ChromosomeLocation: A region of a chromosomed specified by species
     and name using cytogenetic naming conventions
@@ -28,14 +38,14 @@ New classes
   * VariationSet: A set of Variation objects.
 
 Other data model changes
-########################
+$$$$$$$$$$$$$$$$$$$$$$$$
 
   * Interval was renamed to SequenceInterval. Interval was an internal
     class that was never instantiated, so this change should not be
     visiable to users.
 
 Documentation changes
-#####################
+$$$$$$$$$$$$$$$$$$$$$
 
   * Added :ref:`relationships` to describe how VRS relates to other
     standards.
@@ -49,4 +59,7 @@ Documentation changes
 1.0
 @@@
 
-VRS 1.0 was the first public release of the Variation Representation Specification.
+1.0.0
+#####
+
+VRS 1.0.0 was the first public release of the Variation Representation Specification.