Skip to content
This repository has been archived by the owner on Jan 18, 2024. It is now read-only.

Latest commit

 

History

History
45 lines (30 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.58 KB

Contributing to Timescale Helm Charts

We'd love your help!

How to Contribute

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

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

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

Please also see GitHub flow.

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 or appropriate document, describe the manual steps necessary to upgrade to the new (specified) MAJOR version