mirror of
https://github.com/bitnami/charts.git
synced 2026-02-10 20:27:38 +08:00
Add info about README generator in CONTRIBUTING (#8052)
* Add info about README generator in CONTRIBUTING * Update CONTRIBUTING.md Co-authored-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com> Co-authored-by: Carlos Rodríguez Hernández <carrodher1179@gmail.com>
This commit is contained in:
committed by
GitHub
parent
8c6f9615f3
commit
33aedf19ca
@@ -20,7 +20,7 @@ When submitting a PR make sure that it:
|
||||
|
||||
### Documentation Requirements
|
||||
|
||||
- A chart's `README.md` must include configuration options.
|
||||
- A chart's `README.md` must include configuration options. The tables of parameters are generated based on the metadata information from the `values.yaml` file, by using [this tool](ihttps://github.com/bitnami-labs/readme-generator-for-helm).
|
||||
- A chart's `NOTES.txt` must include relevant post-installation information.
|
||||
- The title of the PR starts with chart name (e.g. `[bitnami/chart]`)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user