diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf65d8a..276a717 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ 1. **Fork the repository** and create your branch from `main`. 2. **Make your changes** and ensure they follow the guidelines below. 3. **Test your changes** locally to ensure everything works as expected. This should include deploying your updates to a live Kubernetes cluster (whether local or remote). -4. **Run helm-docs** to ensure that the README is updated with the latest changes. +4. **Run [helm-docs]** to ensure that the README is updated with the latest changes. 5. **Commit your changes** using a descriptive commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. 6. **Push your changes** to your forked repository. 7. **Create a Pull Request** and provide a detailed description of your changes. Please consider dropping us your redacted `values.yaml` file used during your testing in the PR so we can make sure we see consistent results. @@ -37,3 +37,5 @@ If you need any help or have questions about contributing, feel free to reach out to the maintainers of the repository. Thank you for your contributions! + +[helm-docs]: https://github.com/norwoodj/helm-docs