Skip to content

Commit

Permalink
CONTRIBUTING.md: Add link to helm-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
msabramo authored Feb 19, 2025
1 parent fa81927 commit b3f84d0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

0 comments on commit b3f84d0

Please sign in to comment.