oecis-charts/charts/vaultwarden/CONTRIBUTING.md

Contributing Guide

Requirements

1. Fork this repository, develop, and test your changes.
2. Submit a pull request.

Technical Requirements

When submitting a pull request, please ensure that:

• The PR follow Helm best practices.

• Any change to a chart requires a version bump following semver principles.

• The tables of parameters are generated based on the metadata information from the values.yaml file, by using this tool.

  A quick way to do this is to run the tool via Docker:

  # Clone and build:
  git clone https://github.com/bitnami-labs/readme-generator-for-helm
  cd readme-generator-for-helm/
  docker build -t readme-gen .
  
  # Run the tool and mount the current project directory.
  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