Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 3.93 KB
Raw

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 or even adding charts to the repository (if it's viable once evaluated the feasibility).

How to Contribute

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

NOTE: To make the Pull Requests' (PRs) testing and merging process easier, please submit changes to multiple charts in separate PRs.

Technical Requirements

When submitting a PR make sure that it:

  • Must pass CI jobs for linting and test the changes on top of different k8s platforms. (Automatically done by the Bitnami CI/CD pipeline).
  • Must follow Helm best practices.
  • Any change to a chart requires a version bump following semver principles. This is the version that is going to be merged in the GitHub repository, then our CI/CD system is going to publish in the Helm registry a new patch version including your changes and the latest images and dependencies.

Documentation Requirements

  • A chart's README.md must include configuration options. The tables of parameters are generated based on the metadata information from the values.yaml file, by using this tool.
  • A chart's NOTES.txt must include relevant post-installation information.
  • The title of the PR starts with chart name (e.g. [bitnami/chart])

PR Approval and Release Process

  1. Changes are automatically linted and tested using the ct tool as a GitHub action. Those tests are based on helm install, helm lint and helm test commands and provide quick feedback about the changes in the PR. For those tests, the chart is installed on top of kind and this step is not blocking (as opposed to 3rd step).
  2. Changes are manually reviewed by Bitnami team members.
  3. Once the changes are accepted, the PR is tested (if needed) into the Bitnami CI pipeline, the chart is installed and tested (verification and functional tests) on top of different k8s platforms.
  4. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub master branch.
  5. Then our CI/CD system is going to push the chart to the Helm registry including the recently merged changes and also the latest images and dependencies used by the chart. The changes in the images will be also committed by the CI/CD to the GitHub repository, bumping the chart version again.

NOTE: Please note that, in terms of time, may be a slight difference between the appearance of the code in GitHub and the chart in the registry.

Here you can find more information about this process.

Adding a new chart to the repository

There are three major technical requirements to add a new Helm chart to our catalog:

Please, note we will need to check internally and evaluate the feasibility of adding the new solution to the catalog. Due to limited resources this step could take some time.