diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ec0d44cbe495fc868bab1a540f59f8db67e3885..40341c099ec7f7c0778db23e6fba8d99239b5bcb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ See [getting started](docs/getting_started.md) for hints on how to install the c This procedure ensures that your changes do not introduce any unintended issues. ### 4. Update Documentation -If your changes modify or extend the functionality of the chart, do not forget to update the relevant documentation (such as `README.md`, `docs/values.md` or any related configuration files) to reflect these modifications. +If your changes modify or extend the functionality of the chart, do not forget to update the relevant documentation. `README.md` is autogenerated using [helm-docs](https://github.com/norwoodj/helm-docs) so please don't edit this file by hand (modify instead `values.yaml` or `README.md.gotmpl` as needed). Then re-generate the final `README.md` using helm-docs and add those changes too to your change request. ### 5. Submit a Merge Request Once your changes are ready, push your branch to your fork and create a Merge Request (MR) targeting the `master` branch of the main repository.