Contributions are welcome via GitHub pull requests. This document outlines the process to help get your contribution accepted.
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).
- Fork this repository, develop, and test your changes
- Remember to sign off your commits as described above
- Use helm-docs to automatically update documentation regarding your changes.
- Submit a pull request
NOTE: In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs.
- Must pass DCO check
- Must follow Charts best practices
- Must pass CI jobs for linting and installing changed charts with the chart-testing tool
- Any change to a chart requires a version bump following semver principles. See [Immutability(#immutability) and Versioning below
Once changes have been merged, the release job will automatically run to package and release changed charts.
Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation.
The chart version should follow semver.
The major and minor versions should follow the main litmus version. For every change except of litmus' upgrade, you need to bump only patch version.
If your change is not backward compatible and requires extra-steps, be sure to describe it in the Upgrading section in the correspondent README.md.gotmpl, see for an example.