🎉 Thanks for your interest in contributing to this project. In this document we outline a few guidelines to ease the way your contributions flow into this project.
Ensure you have clear and concise commits, written in the present tense. See Kubernetes commit message guidelines for a more detailed explanation of our approach.
+ git commit -m "Bump fluent-bit-out-hsdp chart to version 0.4.0"
- git commit -m "Bumped fluent-bit-out-hsdp chart to version 0.4.0"
Stick with one feature/chart per branch. This allows us to make small controlled releases of the charts and makes it easy for us to review PRs.
Ensure your branch is rebased on top of main before issuing your PR. This to keep a clean Git history and to ensure your changes are working with the latest main branch changes. This also reduces the chance of failing releases.
git checkout main
git pull
git checkout «your-branch»
git rebase main
When bumping any dependency in Chart.yaml ensure you also update the Chart.lock file.
helm dependency update charts/«chart-name»
helm dependency build charts/«chart-name»
Any changes to Chart.yaml or values.yaml require an update of the README.md. This update can easily be generated using helm-docs.
helm-docs -g charts/«chart-name»