diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8b6b682 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to the Open WebUI Helm Charts + +## How to Contribute + +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. **Commit your changes** using a descriptive commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. +5. **Push your changes** to your forked repository. +6. **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. + +## Guidelines + +- **Semantic Versioning**: This repository follows [Semantic Versioning](https://semver.org/) for versioning the Helm Charts. When making changes, please ensure that you update the version in the `Chart.yaml` file according to the following rules: + - `MAJOR` version increment for incompatible chart changes + - `MINOR` version increment for backwards-compatible functionality additions + - `PATCH` version increment for backwards-compatible bug fixes + +- **Chart.yaml Updates**: When submitting a Pull Request, ensure that you have updated the `Chart.yaml` file with the appropriate version increment and a brief description of the changes in the `appVersion` field. + +- **Code Style**: Follow the existing code style and conventions used in the repository. + +- **Documentation**: If your changes require documentation updates, please include them in your Pull Request. + +- **Testing**: Before submitting your Pull Request, ensure that your changes work as expected by testing them locally. This should include deploying your updates to a live Kubernetes cluster (whether local or remote). + +- **Issues**: If you find any issues or have suggestions for improvements, please create a new issue in the repository before working on a Pull Request. + +## Getting Help + +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!