-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add contributing docs * apply suggestion * apply suggestion
- Loading branch information
1 parent
cf83f1f
commit 6f633b3
Showing
1 changed file
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Contributing | ||
|
||
Contributions are welcome through GitHub pull request. This document outlines the steps to facilitate the acceptance of your contribution. | ||
|
||
## How to Contribute | ||
|
||
1. Fork repository, develop, and test your changes. | ||
2. Bump the chart version and update chart documentation. | ||
3. Submit a pull request. | ||
|
||
To simplify testing and merging, please submit changes for only one chart per pull request. | ||
|
||
### Technical Requirements | ||
|
||
* Must follow [charts best practices](https://helm.sh/docs/topics/chart_best_practices/). | ||
* Must pass CI jobs for linting and installing changed charts with the [chart-testing](https://github.com/helm/chart-testing) tool. | ||
* Any change to a chart requires a version bump following [semver](https://semver.org/) principles. See [Immutability](#immutability) and [Versioning](#versioning) below. | ||
|
||
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, including documentation updates, requires bumping the chart version. | ||
|
||
### Versioning | ||
|
||
Version numbers follow [semantic versioning](https://semver.org/). 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. | ||
|
||
### Generate documentation | ||
|
||
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: | ||
|
||
```shell | ||
make docs | ||
``` | ||
|
||
### Community Requirements | ||
|
||
This project is released with a [Contributor Covenant](https://www.contributor-covenant.org). | ||
By participating in this project you agree to abide by its terms. | ||
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). |