Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

64 lines (46 loc) · 3.91 KB

Contributing Guidelines

This charts project accepts contributions via GitHub pull requests. This document outlines the process to help get your contribution accepted.

Reporting a Bug in Helm

This repository is used by Chart developers for maintaining the official charts for Kubernetes Helm. If your issue is in the Helm tool itself, please use the issue tracker in the helm/helm repository.

How to Contribute to an Existing Chart

  1. Fork this repository, develop and test your Chart changes.
  2. Please allow edits from maintainers so small changes can be added if necessary.
  3. Ensure your Chart changes follow the technical and documentation guidelines, described below.
  4. Submit a pull request.

Technical Requirements

  • All Chart dependencies should also be submitted independently
  • Must pass the linter (helm lint)
  • Must successfully launch with default values (helm install .)
    • All pods go to the running state (or NOTES.txt provides further instructions if a required value is missing e.g. minecraft)
    • All services have at least one endpoint
  • Must include source GitHub repositories for images used in the Chart
  • Images should not have any major security vulnerabilities
  • Must be up-to-date with the latest stable Helm/Kubernetes features
    • Use Deployments in favor of ReplicationControllers
  • Should follow Kubernetes best practices
  • Provide a method for data persistence (if applicable)
  • Support application upgrades
  • Allow customization of the application configuration
  • Provide a secure default configuration
  • Do not leverage alpha features of Kubernetes
  • Includes a NOTES.txt explaining how to use the application after install
  • Follows best practices (especially for labels and values)

Documentation Requirements

  • Please update the README.md.gotmpl file and not the README.md, as the README.md is automatically generated with helm-docs
  • Please update NOTES.txt if necessary, including:
    • Any relevant post-installation information for the Chart
    • Instructions on how to access the application or service provided by the Chart

Add yourself to the list of contributors

See the documentation on how to use the bot here

Merge Approval and Release Process

A maintainer will review the Chart change submission, a validation job in the CI is automatically started. A maintainer may add "LGTM" (Looks Good To Me) or an equivalent comment to indicate that a PR is acceptable. Any change requires at least one LGTM. No pull requests can be merged until at least one maintainer signs off with an LGTM.

Once the Chart has been merged, the release job will automatically run in the CI to package and release the Chart.

Support Channels

Whether you are a user or contributor, official support channels include:

Before opening a new issue or submitting a new pull request, it's helpful to search the project - it's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of.