-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
amitz
committed
Aug 7, 2024
1 parent
92119d7
commit 7f309f7
Showing
2 changed files
with
41 additions
and
1 deletion.
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 |
---|---|---|
|
@@ -16,4 +16,3 @@ jobs: | |
days-before-issue-stale: 730 | ||
days-before-pr-close: 14 | ||
days-before-issue-close: 30 | ||
|
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,41 @@ | ||
# Contributing Guide | ||
|
||
We'd love your help! | ||
|
||
## How to Contribute | ||
|
||
1. Fork this repository | ||
1. Develop, and test your changes | ||
1. Submit a pull request | ||
|
||
Remember to always work in a branch of your local copy, as you might otherwise | ||
have to contend with conflicts in main. | ||
|
||
### 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 warrants a chart version | ||
bump even if it is only changed to the documentation. | ||
|
||
### Versioning | ||
|
||
The chart `version` should follow [semver](https://semver.org/). | ||
|
||
All changes to a chart require a version bump, following semvar. | ||
|
||
Any breaking (backwards incompatible) changes to a chart should: | ||
|
||
1. Bump the MINOR version | ||
2. In the README, under a section called "Upgrading", describe the manual steps | ||
necessary to upgrade to the new (specified) MAJOR version |