From 6d768163c55932fe343b7c41b0acd3f1d2136caa Mon Sep 17 00:00:00 2001 From: amarouane Date: Thu, 18 Feb 2021 14:06:21 -0600 Subject: [PATCH] Add versioning documentation --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c096bfa..bdfd874 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,18 @@ # Overview DMR++ files generator is a cloud based activity that generate DMRPP files from netCDF4 and HDF files ## 📖 Documentation +- Release note [v1.1.0](https://ghrcdaac.github.io/dmrpp-generator/). - Release note [v1.0.6](https://ghrcdaac.github.io/dmrpp-generator/). - Release note [v1.0.5](https://ghrcdaac.github.io/dmrpp-generator/). - Release note [v1.0.4](https://ghrcdaac.github.io/dmrpp-generator/). +## Versioning +We are following `v..` versioning convention, where: +* `+1` means we changed the infrastructure and/or the major components that makes this software run. Will definitely + lead to breaking changes. +* `+1` means we upgraded/patched the dependencies this software relays on. Can lead to breaking changes. +* `+1` means we fixed a bug and/or added a feature. Breaking changes are not expected. + # 🔨 Pre-requisite This module is meant to run within Cumulus stack. If you don't have Cumulus stack deployed yet please consult [this repo](https://github.com/nasa/cumulus)