Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.97 KB

Contributing guidelines

Contributions are welcome via GitHub Pull Requests. This document outlines the process to help get your contribution accepted.

Any type of contribution is welcome; from new features, bug fixes, documentation improvements.

How to contribute?

  1. Fork this repository, develop and test your changes on a new branch.
  2. Submit a pull request, the title of the PR starts with the chart name (e.g. [canton/participant]).
  3. If your PR corresponds to an issue, add Fixes #XXX to your pull request description.

NOTE: To make the Pull Requests' (PRs) testing and merging process easier, please submit changes to multiple charts in separate PRs. If there are too many changes to the same Helm chart, try also to break it down into separate PRs.

Technical requirements

When submitting a PR make sure that:

Documentation requirements

Markdown ## Parameters section of each Helm chart README.md is automatically generated based on formatted comments in values.yaml using the latest version of Bitnami Labs' Readme Generator For Helm and no specific configuration file (defaults).

cd path/to/chart/
readme-generator -v values.yaml -r README.md

⚠️ values.yaml must be a valid YAML file before you run the readme-generator tool, otherwise you will get cryptic errors. You can use yamllint to verify the file if you do not already have syntax/formatting validation in your favorite IDE.

PR approval and release process

  1. Changes are manually reviewed and tested by Digital Asset.
  2. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub main branch.
  3. We will release a new Helm chart version with our CI/CD system and make it available in the repository and refresh Artifact Hub.