docs: development guide

Signed-off-by: Bruno Bressi <bruno.bressi@telekom.de>
caas-team · Oct 2, 2024 · 6b2cddc · 6b2cddc
1 parent ace25ad
commit 6b2cddc
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/Chart.yaml b/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 name: caas-project-monitoring
 description: A Helm chart for Rancher Project Monitoring V3.
-version: "1.3.0"
+version: "1.3.0-rc0"
 appVersion: "58.4.0"
 icon: https://raw.githubusercontent.com/caas-team/caas-project-monitoring/main/logo.png
 keywords:

diff --git a/charts/kube-prometheus-stack-58.4.0.tgz b/charts/kube-prometheus-stack-58.4.0.tgz
diff --git a/docs/app-readme.md b/docs/app-readme.md
@@ -88,3 +88,14 @@ rules:
 ```
 
 </details>
+
+## Development
+
+If you need to make any changes to the chart, you should follow this general development process:
+
+1. Change any files needed for the chart.
+2. Update any dependencies by using the Chart.yaml, if needed.
+3. Update the README.md.gotmpl, if needed.
+4. Update the app-readme.md, if needed.
+5. Run `make chart` to prepare the chart for packaging.
+6. Open a PR with the changes.