Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.4 KB

Contributing Guidelines

Contributions are welcome via Github pull requests. This document outlines the process to help get your contribution accepted.

How to Contribute

  1. Fork this repository
  2. Add you chart under charts/ directory
  3. Test your changes
  4. Submit a pull request along with the description

NOTE: In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs.

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