Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 2.8 KB

Contributing Guidelines

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

Sign off Your Work

The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO. Contributors must sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

This is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

See git help commit:

-s, --signoff
    Add Signed-off-by line by the committer at the end of the commit log
    message. The meaning of a signoff depends on the project, but it typically
    certifies that committer has the rights to submit this work under the same
    license and agrees to a Developer Certificate of Origin (see
    http://developercertificate.org/ for more information).

How to Contribute

  1. Fork this repository
  2. Install all pre-commit hooks - make initialise in the root of the repository
  3. Make your changes
  4. Test your changes
  5. Remember to sign off your commits as described above
  6. Submit a pull request

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

Technical Requirements

  • Must pass DCO check
  • Must follow Charts best practices
  • Must pass all pre-commit hooks. To install pre-commit hooks, run make initialise in the root of the repository
  • Any change to a chart requires a version bump following semver principles. See Immutability and Versioning below
  • Please remember to update the README.md.gotmpl
  • Please remember to update the Chart.yaml with the new version number and update artifacthub.io/changes section with the changes made in the chart

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 a change 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
  3. New issue should be started to discuss the changes and the need for a new MAJOR version