Skip to content

Commit a96d0b5

Browse files
committed
doc: Describe the process to become a maintainer
Signed-off-by: Manuel Rüger <[email protected]>
1 parent a577a59 commit a96d0b5

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

MAINTAINER.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Maintaining kube-state-metrics
2+
3+
kube-state-metrics is welcoming contributions from the community. If you are interested in intensifying your contributions and becoming a maintainer, this doc describes the necessary steps.
4+
5+
As part of the Kubernetes project, we use the community membership process as described [here](https://github.com/kubernetes/community/blob/master/community-membership.md). We do not adhere strictly to the numbers of contributions and reviews. Still as becoming a maintainer is a trust-based process and we desire positive outcomes for the project, we look for a long-term interest and engagement.
6+
7+
## Adding a new reviewer
8+
* Ensure the new reviewer is a member of the [kubernetes organization](https://github.com/kubernetes/org/blob/main/config/kubernetes/org.yaml).
9+
* Add the new reviewer to the [OWNERS](OWNERS) file to be able to review pull requests.
10+
* Add the new reviewer to the [kube-state-metrics-maintainers group](https://github.com/kubernetes/org/blob/main/config/kubernetes/sig-instrumentation/teams.yaml), to gain write access to the kube-state-metrics repository (e.g. for creating new releases).
11+
12+
13+
## Adding a new approver
14+
* Ensure the new approver is already a reviewer in the [OWNERS](OWNERS) file.
15+
* Add the new approver to the [OWNERS](OWNERS) file to be able to approve pull requests.
16+
* Add the new approver to the [SECURITY_CONTACTS](SECURITY_CONTACTS) file to be able to get notified on security related incidents.
17+
* Add the new approver to the [kube-state-metrics-admin group](https://github.com/kubernetes/org/blob/main/config/kubernetes/sig-instrumentation/teams.yaml), to get admin access to the kube-state-metrics repository.
18+
* Add the new approver to the k8s.io [OWNERS](https://github.com/kubernetes/k8s.io/blob/main/k8s.gcr.io/images/k8s-staging-kube-state-metrics/OWNERS) file to be able to approve image promotion from the staging registry.

0 commit comments

Comments
 (0)