Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 3.34 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.

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.
  • Implements changes in both files if the chart contains a values-production.yaml and a values.yaml.
  • Has the "edits and maintainers" option enabled to allow our CI/CD to modify the PR (bitnami-bot will update values*.yaml). Find more information in this link.
  • Any change to a chart requires a version bump following semver principles.

Documentation Requirements

  • A chart's README.md must include configuration options.
  • 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 into the Bitnami CI pipeline, the chart is installed and tested (verification and functional tests) on top of different k8s platforms.
  4. If everything works fine, the bitnami-bot will add a new commit to the PR updating all the Docker images tags and dependencies. If something fails, the review process continues.
  5. When the PR passes all tests it is merged in the GitHub master branch and the new version of the chart is pushed to the registry. Please note that may be a slight difference between the appearance of the code in GitHub and the chart in the registry.

Adding a new chart to the repository

There are only three major requirements to add a new chart in our catalog: