diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f7e1024f6..27d61039c3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,12 +19,31 @@ Follow either of the two links above to access the appropriate CLA and instructi 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 [kubernetes/helm](https://github.com/kubernetes/helm) repository. +### Repository Structure + +The Charts in this repository are organized into two folders: +* stable +* incubator + +Stable Charts: + +1. Provide a method for data persistence +1. Support application upgrades +1. Allow customization of the application configuration +1. Provide a secure default configuration +1. Do not leverage alpha features of Kubernetes + +Incubator Charts are those that do not meet these criteria. Having the incubator folder allows charts to be shared and improved on until they are ready to be moved into the stable folder. + +In order to get a Chart from incubator to stable, Chart maintainers should open a pull request that moves the chart folder. + ### How to contribute a Chart 1. If you haven't already done so, sign a Contributor License Agreement (see details above). -2. Fork this repository, develop and test your Chart. -3. Ensure your Chart follows the technical and documentation guidelines, described below. -4. Submit a pull request. +1. Fork this repository, develop and test your Chart. +1. Choose the correct folder for your chart based on the information in the [Repository Structure](#repository-structure) section +1. Ensure your Chart follows the [technical](#technical-requirements) and [documentation](#documentation-requirements) guidelines, described below. +1. Submit a pull request. #### Technical requirements