Skip to content

Commit 47e817e

Browse files
Add versioning notes to changelog
1 parent 3606ecc commit 47e817e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CHANGELOG.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,19 @@ Internal changes to support unit testing
106106
------------
107107

108108
* `GEOPHIRES v1 </References/Beckers%202013%20GEOPHIRES%20v1.pdf>`__
109+
110+
111+
Versioning Notes
112+
----------------
113+
114+
GEOPHIRES 3.0 (GEOPHIRES-X) and subsequent releases use `semantic versioning <https://en.wikipedia.org/wiki/Software_versioning#Semantic_versioning>`__.
115+
Major, minor, and notable patch versions are documented above.
116+
You may also be interested in viewing the list of all PRs merged into the repository `here <https://github.com/NREL/GEOPHIRES-X/pulls?q=is%3Apr+is%3Amerged+>`__.
117+
118+
Each semantic version has a corresponding tag, the full list of which can be viewed `here <https://github.com/NREL/GEOPHIRES-X/tags>`__.
119+
The latest patch version in this repository and patch versions explicitly mentioned in this changelog are always suitable for public consumption;
120+
but note that not all patch version tags in the list are meant for public consumption
121+
as intermediate internal-only patch versions are sometimes introduced during the development process.
122+
(Improved designation and distribution of releases for public consumption may eventually be addressed by
123+
`publishing to PyPI <https://github.com/NREL/GEOPHIRES-X/issues/117>`__ and/or use of
124+
`GitHub releases <https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases>`__.)

0 commit comments

Comments
 (0)