CONTRIBUTING.md

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 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.
• A chart's NOTES.txt must include relevant post-installation information.
• The title of the PR starts with chart name (e.g. [sickhub/chart])

PR Approval and Release Process

1. Changes are automatically linted and tested using the ct tool with CI Pipeline. 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.
2. Changes are manually reviewed by contributors.
3. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub master branch.
4. Then a maintainer will package and push the chart to GitHub Pages and Artifact Hub.

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.

Adding a new chart to the repository

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

• The chart must use public container images. If they don't exist, you can open a GitHub issue and we will work together to create them.
• Follow the same structure/patterns that the rest of the charts and other publicly accepted examples
  • See https://github.com/bitnami/charts/tree/master/template
  • And Best Practices for Creating Production-Ready Helm charts
• Use an OSI approved license for all the software.

Credits

• Inspired by the CONTRIBUTING guide lines of bitnami.