🎉 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 rekor chart to version 1.0.0"
- git commit -m "Bumped rekor chart to version 1.0.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.
git checkout main
git pull
git checkout «your-branch»
git rebase mainWhen bumping image versions it is important you use the image digest as opposed to the tag.
See below a easy workflow to figure out the image digest and latest available tags using crane.
$ crane ls ghcr.io/sigstore/scaffolding/createtree
…
sha256-6c0722e2140d14982a9addbeffd6a5fc6c53ecd44d138138c2eebc14129ab3e8.sbom
v0.4.6
sha256-c293fcb546619a71eabba16f231e0262d7614f2bb90fb53dda2713bbef71dac5.sig
$ crane digest ghcr.io/sigstore/scaffolding/createtree:v0.4.6
sha256:c293fcb546619a71eabba16f231e0262d7614f2bb90fb53dda2713bbef71dac5When 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»