Contributions are welcome through GitHub pull request. This document outlines the steps to facilitate the acceptance of your contribution.
- Fork repository, develop, and test your changes.
- Bump the chart version and update chart documentation.
- Submit a pull request.
To simplify testing and merging, please submit changes for only one chart per pull request.
- 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 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, including documentation updates, requires bumping the chart version.
Version numbers follow semantic versioning. When making changes to a chart, update the version in Chart.yaml as follows:
-
MAJOR version (x.0.0): Incompatible API changes
- Breaking changes to values.yaml structure.
- Removal of deprecated features.
- Major Kubernetes version requirement changes.
-
MINOR version (0.x.0): Added functionality in a backward compatible manner
- New optional parameters or features.
- New capabilities that maintain backward compatibility.
-
PATCH version (0.0.x): Backward compatible bug fixes or documentation updates
- Bug fixes that don't change the chart's functionality.
- Documentation improvements.
- Minor clarifications or corrections.
Documentation for charts is automatically generated from the following sources:
- Chart.yaml: Metadata and version information.
- values.yaml: Configuration options and defaults.
- README.md.gotmpl: Template for the chart's README.
To regenerate documentation after making changes:
make docsThis project is released with a Contributor Covenant. By participating in this project you agree to abide by its terms. See CODE_OF_CONDUCT.md.