From 38a0894fa5a0333a54c1d49c2d7468aef760391a Mon Sep 17 00:00:00 2001 From: Lester Guerzon Date: Fri, 1 Apr 2022 10:45:05 +0200 Subject: [PATCH] docs: improvements to the contributing guide Signed-off-by: Lester Guerzon --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 793f74d..89fc871 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,15 +8,13 @@ ### Technical Requirements -When submitting a PR make sure that it: +When submitting a pull request, please ensure that: - The PR follow [Helm best practices](https://helm.sh/docs/chart_best_practices/). - - Any change to a chart requires a version bump following [semver](https://semver.org/) principles. - - The tables of parameters are generated based on the metadata information from the `values.yaml` file, by using [this tool](https://github.com/bitnami-labs/readme-generator-for-helm). - The easiest way to do this is to run the tool via Docker: + A quick way to do this is to run the tool via Docker: ```bash # Clone and build: @@ -28,4 +26,8 @@ When submitting a PR make sure that it: cd docker run --rm -d -it --name readmegen -v $(pwd):/mnt readme-gen bash docker exec -it readmegen bash + + # Update the values documentation + cd /mnt + readme-generator -v values.yaml -r README.md ```