Skip to content

Commit bd388de

Browse files
authored
Merge pull request opencloud-eu#35 from ferenc-hechler/update-community-governance
Add community governance structure
2 parents a1b94c9 + 1c6e893 commit bd388de

File tree

3 files changed

+87
-5
lines changed

3 files changed

+87
-5
lines changed

CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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.

MAINTAINERS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Maintainers
2+
3+
This file lists the maintainers and reviewers for the OpenCloud Helm Charts repository.
4+
5+
## Maintainers
6+
7+
Maintainers have the ability to merge PRs, create releases, and guide the overall direction of the project.
8+
9+
- @butonic
10+
11+
## Reviewers
12+
13+
Reviewers have the ability to review PRs and approve them, but do not have merge access.
14+
15+
- @michaelstingl
16+
- @WrenIX
17+
- @ferenc-hechler
18+
- @suse-coder
19+
20+
## Becoming a Maintainer or Reviewer
21+
22+
Contributors who make multiple high-quality PRs may be invited to become Reviewers.
23+
Reviewers who are consistently active and provide valuable reviews may be invited to become Maintainers.
24+
25+
If you're interested in becoming a maintainer or reviewer, please continue contributing and engaging with the project.

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,16 @@ For general OpenCloud discussions:
4949

5050
## 💡 Contributing
5151

52-
We encourage contributions from the community! If you'd like to contribute:
53-
- Fork this repository
54-
- Submit a Pull Request
55-
- Discuss and collaborate on issues
52+
We encourage contributions from the community! This repository follows a community-driven development model with defined roles and responsibilities.
5653

57-
Please ensure that your PR follows best practices and includes necessary documentation.
54+
For detailed contribution guidelines, please see our [CONTRIBUTING.md](./CONTRIBUTING.md) document.
55+
56+
This includes:
57+
- How to submit contributions
58+
- Our community governance model
59+
- How to become a reviewer or maintainer
60+
61+
The current maintainers and reviewers are listed in [MAINTAINERS.md](./MAINTAINERS.md).
5862

5963
## Prerequisites
6064

0 commit comments

Comments
 (0)