Skip to content

Commit 13290e8

Browse files
author
Naadir Jeewa
committed
CONTRIBUTING.md: Clarify contribution ladder
Signed-off-by: Naadir Jeewa <[email protected]>
1 parent 3a58c16 commit 13290e8

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,62 @@ Kubernetes projects require that you sign a Contributor License Agreement (CLA)
1717
* 🐛 (:bug:, patch and bugfixes)
1818
* 📖 (:book:, documentation or proposals)
1919
* 🌱 (:seedling:, minor or other)
20+
21+
### Contributer Ladder
22+
23+
We broadly follow the requirements from the [Kubernetes Community Membership](https://github.com/kubernetes/community/blob/master/community-membership.md).
24+
25+
> When making changes to **OWNER_ALIASES** please check that the **sig-cluster-lifecycle-leads**, **cluster-api-admins** and **cluster-api-maintainers** are correct.
26+
27+
#### Becoming a reviewer
28+
29+
If you would like to become a reviewer, then please ask one of the current maintainers.
30+
31+
We generally try to follow the [requirements for a reviewer](https://github.com/kubernetes/community/blob/master/community-membership.md#reviewer) from upstream Kubernetes. But if you feel that you don't fully meet the requirements then reach out to us, they are not set in stone.
32+
33+
A reviewer can get PRs automatically assigned for review, and can `/lgtm` PRs.
34+
35+
To become a reviewer, ensure you are a member of the **kubernetes-sigs** Github organisation
36+
following [kubernetes/org/issues/new/choose](https://github.com/kubernetes/org/issues/new/choose).
37+
38+
The steps to add someone as a reviewer are:
39+
40+
* Add the GitHub alias to the **cluster-api-vsphere-reviewers** section of [OWNERS_ALIASES](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/main/OWNERS_ALIASES)
41+
* Create a PR with the change that is held (i.e. by using `/hold`)
42+
* Announce the change within the CAPV slack channel and as a PSA in the next CAPV office hours
43+
* After 7 days of lazy consensus or after the next CAPV office hours (whichever is longer) the PR can be merged
44+
45+
#### Becoming a maintainer
46+
47+
If you have made significant contributions to Cluster API Provider vSphere, a maintainer may nominate you to become a maintainer for the project.
48+
49+
We generally follow the [requirements for a approver](https://github.com/kubernetes/community/blob/master/community-membership.md#approver) from upstream Kubernetes. However, if you don't fully meet the requirements then a quorum of maintainers may still propose you if they feel you will make significant contributions.
50+
51+
Maintainers are able to approve PRs, as well as participate in release processes and have write access to the repo. **As a maintainer you will be expected to run the office hours, especially if no one else wants to**.
52+
53+
Maintainers require membership of the **Kubernetes** Github organisation via
54+
[kubernetes/org/issues/new/choose](https://github.com/kubernetes/org/issues/new/choose)
55+
56+
The steps to add someone as a maintainer are:
57+
58+
* Add the GitHub alias to the **cluster-api-vsphere-maintainers** and remove them from **cluster-api-vsphere-reviewers** sections of [OWNERS_ALIASES](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/main/OWNERS_ALIASES)
59+
* Create a PR with the change that is held (i.e. by using `/hold`)
60+
* Announce the change within the CAPV slack channel and as a PSA in the next CAPV office hours
61+
* After 7 days of lazy consensus or after the next CAPV office hours (whichever is longer) the PR can be merged
62+
* Open PR to add Github username to **cluster-api-provider-vsphere-maintainers**
63+
to [kubernetes/org/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml](https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml)
64+
* Open PR to add Github username to [kubernetes/test-infra/config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/OWNERS](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/OWNERS)
65+
* Open PR to add Google ID to the [email protected] and [email protected] Google groups in [kubernetes/k8s.io/groups/sig-cluster-lifecycle/groups.yaml](https://github.com/kubernetes/k8s.io/blob/main/groups/sig-cluster-lifecycle/groups.yaml)
66+
* Open PR to add approvers/reviewers to [CAPV image promotion](https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-cluster-api-vsphere/OWNERS).
67+
* Open PR to image-builder to modify `cluster-api-vsphere-maintainers` in [OWNERS_ALIASES](https://github.com/kubernetes-sigs/image-builder/blob/main/OWNERS_ALIASES)
68+
69+
#### Becoming a admin
70+
71+
After a period of time one of the existing CAPV or CAPI admins may propose you to become an admin of the CAPV project.
72+
73+
Admins have GitHub **admin** access to perform tasks on the repo.
74+
75+
The steps to add someone as an admin are:
76+
77+
* Open PR to add Github username to **cluster-api-provider-vsphere-admins**
78+
to [kubernetes/org/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml](https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml)

0 commit comments

Comments
 (0)