From 213d3abcc0736e2dd54b27c6fb16641346826516 Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Wed, 6 Feb 2019 15:22:50 -0500 Subject: [PATCH] Add versioning policies to review guidelines Fixes #5657 Signed-off-by: Scott Rigby --- REVIEW_GUIDELINES.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/REVIEW_GUIDELINES.md b/REVIEW_GUIDELINES.md index 880cbf546a93..eadf19519081 100644 --- a/REVIEW_GUIDELINES.md +++ b/REVIEW_GUIDELINES.md @@ -16,6 +16,17 @@ Note, if a reviewer who is not an approver in an OWNERS file leaves a comment of Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changes to the documentation. +## Versioning + +The chart `version` should follow [semver](https://semver.org/). + +Stable charts should start at `1.0.0` (for maintainability don't create new PRs for stable charts only to meet this criteria, but when reviewing PRs take the opportunity to ensure that this is met). + +Any breaking (backwards incompatible) changes to a chart should: + +1. Bump the MAJOR version +2. In the README, under a section called "Upgrading", describe the manual steps necessary to upgrade to the new (specified) MAJOR version + ## Chart Metadata The `Chart.yaml` should be as complete as possible. The following fields are mandatory: