From fb27334ac03e4c45976a76c2e0eec78aadb5375a Mon Sep 17 00:00:00 2001 From: Charlie Le Date: Sun, 15 Jun 2025 16:56:37 +0000 Subject: [PATCH] docs: add contributing guidelines to the repository --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a338544b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to cortex-helm-chart + +Thank you for your interest in contributing to the cortex-helm-chart project! + +## How to Contribute + +1. **Fork the repository** and create your branch from `master`. +2. **Make your changes** in the appropriate files (for example, `README.md.gotmpl` or `values.yaml`). +3. **Update the generated README.md**: + + The `README.md` file is generated automatically. After making changes to `README.md.gotmpl` or `values.yaml`, run the following command to update `README.md`: + + ```sh + make README.md + ``` + + This command uses [helm-docs](https://github.com/norwoodj/helm-docs) in a Docker container to regenerate the documentation. + +4. **Commit your changes**, including the updated `README.md`. +5. **Push your branch** and open a Pull Request with a clear description of your changes. + +## Guidelines + +- Please discuss any major changes via issue before submitting a pull request. +- Ensure your code and documentation changes are clear and concise. +- Follow the existing style and conventions of the repository. + +Thank you for helping improve cortex-helm-chart!