From 723985f71808f499f7b72da6b9bdd7505c05af2f Mon Sep 17 00:00:00 2001 From: Jiri Podivin Date: Tue, 24 May 2022 09:58:47 +0200 Subject: [PATCH] Explaining stable branches in CONTRIBUTING.rst Signed-off-by: Jiri Podivin Change-Id: I429f65498960f3555326f23b1ec2af592414a95f --- CONTRIBUTING.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fb406eb..84da616 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -4,7 +4,20 @@ It covers all the basics that are common to all OpenStack projects: the accounts you need, the basics of interacting with our Gerrit review system, how we communicate as a community, etc. -The information below will cover the project specific information you need to get started with TripleO. +The information below will cover the project specific information you'll +need to get started with validation-framework. + +Branches and version management +=============================== +Validation Framework project uses semantic versioning and derives names of stable branches +from the released minor versions. The latest minor version released is the only exception +as it is derived from the `master` branch. + +Therefore, all code used by version 1.n.* of the project resides in `stable/1.n` branch, +and when version 1.(n+1) is released, new branch `stable/1.(n+1)` will be created. + +By default, stable branches recieve only bug fixes and feature backports are decided on case basis +after all the necessary discussions and procedures have taken place. Documentation =============