From eacbf95b91cbb324d26e22753bef6911383bbcdb Mon Sep 17 00:00:00 2001 From: Allen Porter Date: Mon, 21 Feb 2022 10:33:27 -0800 Subject: [PATCH] Update contributing instructions (#1429) * Update contributing instructions for breaking changes Update documentation for how to update breaking changes based on the move to annotations and artifacthub. * Simplify contributing documentation Remove detail from the documentation for breaking changes. Remove unnecessary wording in the chart contributing instructions. --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 796f3cd1..8b43ba33 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,10 +47,8 @@ Chart releases must be immutable. Any change to a chart warrants a chart version The chart `version` should follow [semver](https://semver.org/). -Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to a chart should: +Charts should start at `1.0.0`. Any any breaking (backwards incompatible) changes should Bump the MAJOR version, and should describe the manual steps necessary to upgrade. All changes should be described in in the [Chart metadata](https://docs.k8s-at-home.com/our-helm-charts/development/creating-a-new-chart/#chart-metadata). -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 ### Pre-commit