From 0bd6d57834ca050c2f7f5f4b4425932e8bd24a3b Mon Sep 17 00:00:00 2001 From: Ludovic Ortega Date: Mon, 17 Mar 2025 10:50:08 +0100 Subject: [PATCH] docs(helm): add contributing guidelines for helm chart (#1486) Signed-off-by: Ludovic Ortega --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1835e949f..27e2bfbbd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,12 +58,27 @@ All help is welcome and greatly appreciated! If you would like to contribute to - Be sure to follow both the [code](#contributing-code) and [UI text](#ui-text-style) guidelines. - Should you need to update your fork, you can do so by rebasing from `upstream`: + ```bash git fetch upstream git rebase upstream/develop git push origin BRANCH_NAME -f ``` +### Helm Chart + +Tools Required: + +- [Helm](https://helm.sh/docs/intro/install/) +- [helm-docs](https://github.com/norwoodj/helm-docs) + +Steps: + +1. Make the necessary changes. +2. Test your changes. +3. Update the `version` in `charts/jellyseerr-chart/Chart.yaml` following [Semantic Versioning (SemVer)](https://semver.org/). +4. Run the `helm-docs` command to regenerate the chart's README. + ### Contributing Code - If you are taking on an existing bug or feature ticket, please comment on the [issue](https://github.com/fallenbagel/jellyseerr/issues) to avoid multiple people working on the same thing.