master-group/charts
2
0
Fork 0
mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-23 15:39:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update contributing instructions (#1429)

Browse Source 
* 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.
This commit is contained in:
Allen Porter 2022-02-21 10:33:27 -08:00 committed by GitHub
parent 7ee1f9914d
commit eacbf95b91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -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