Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.45 KB

Contributing Guide

We'd love your help!

How to Contribute

  1. Fork this repository
  2. Develop, and test your changes
  3. Submit a pull request

Remember to always work in a branch of your local copy, as you might otherwise have to contend with conflicts in master.

Please also see GitHub workflow section of general project contributing guide.

Technical Requirements

Once changes have been merged, the release job will automatically run to package and release changed charts.

Immutability

Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation.

Versioning

The chart version should follow semver.

Charts should start at 0.1.0 or 1.0.0. 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