OpenWebUI/helm-charts
1
0
Fork 0
mirror of https://github.com/open-webui/helm-charts synced 2025-06-26 18:16:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CONTRIBUTING.md: Add link to helm-docs

Browse Source 
Add link to helm-docs: https://github.com/norwoodj/helm-docs
This commit is contained in:
Marc Abramowitz 2025-02-19 08:32:18 -08:00 committed by GitHub
parent fa81927fe2
commit b3f84d0dbf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -8,7 +8,7 @@
1. **Fork the repository** and create your branch from `main`. 1. **Fork the repository** and create your branch from `main`.
2. **Make your changes** and ensure they follow the guidelines below. 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). 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. 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. 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. 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. 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! Thank you for your contributions!
[helm-docs]: https://github.com/norwoodj/helm-docs