|
| 1 | +# Contributing to OpenCloud Helm Charts |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the OpenCloud Helm Charts repository! |
| 4 | + |
| 5 | +## Repository Structure |
| 6 | + |
| 7 | +This repository follows a community-driven approach with a simple role model: |
| 8 | + |
| 9 | +- **Contributors**: Anyone who submits PRs |
| 10 | +- **Reviewers**: Experienced contributors who can review and approve PRs |
| 11 | +- **Maintainers**: Active reviewers who can additionally merge PRs and manage releases |
| 12 | + |
| 13 | +You can find the current list of maintainers and reviewers in the [MAINTAINERS.md](./MAINTAINERS.md) file. |
| 14 | + |
| 15 | +## Contribution Workflow |
| 16 | + |
| 17 | +### 1. Fork and Clone |
| 18 | + |
| 19 | +```bash |
| 20 | +git clone https://github.com/YOUR-USERNAME/helm.git |
| 21 | +cd helm |
| 22 | +git remote add upstream https://github.com/opencloud-eu/helm.git |
| 23 | +``` |
| 24 | + |
| 25 | +### 2. Create a Branch |
| 26 | + |
| 27 | +```bash |
| 28 | +git checkout -b feature/your-feature-name |
| 29 | +``` |
| 30 | + |
| 31 | +### 3. Make Changes and Test |
| 32 | + |
| 33 | +When making changes, please ensure you: |
| 34 | +- Follow Helm best practices |
| 35 | +- Include proper documentation |
| 36 | +- Test your changes with `helm lint` and installation tests |
| 37 | + |
| 38 | +### 4. Submit a Pull Request |
| 39 | + |
| 40 | +- Create a PR from your fork to the main repository |
| 41 | +- Ensure your PR has a clear description of the changes |
| 42 | +- At least one reviewer must approve before a maintainer can merge |
| 43 | + |
| 44 | +## Code of Conduct |
| 45 | + |
| 46 | +This project follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). |
| 47 | + |
| 48 | +## Becoming a Maintainer or Reviewer |
| 49 | + |
| 50 | +Contributors who make multiple high-quality PRs may be invited to become Reviewers. |
| 51 | +Reviewers who are consistently active and provide valuable reviews may be invited to become Maintainers. |
| 52 | + |
| 53 | +If you're interested in becoming a maintainer or reviewer, please continue contributing and engaging with the project. |
0 commit comments