The APPUiO Charts project accepts contributions via GitHub pull requests. This document outlines the process to help get your contribution accepted.
- Fork this repository, develop and test your Chart.
- Ensure your Chart follows the technical and documentation guidelines, described below.
- Submit a pull request.
NOTE: In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs.
- All Chart dependencies should also be submitted independently
- Must pass the linter (
helm lint
) - 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
- Include Health Checks wherever practical
- Allow configurable resource requests and limits
- 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)
- Must include an in-depth
README.md
, including:- Short description of the Chart
- Any prerequisites or requirements
- Customization: explaining options in
values.yaml
and their defaults
- Must include a short
NOTES.txt
, including:- Any relevant post-installation information for the Chart
- Instructions on how to access the application or service provided by the Chart