Skip to content

Commit

Permalink
docs: improvements to the contributing guide
Browse files Browse the repository at this point in the history
Signed-off-by: Lester Guerzon <[email protected]>
  • Loading branch information
Lester Guerzon committed Apr 1, 2022
1 parent f8b10ea commit 38a0894
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -28,4 +26,8 @@ When submitting a PR make sure that it:
cd <this-project-dir>
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
```

0 comments on commit 38a0894

Please sign in to comment.