You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+52-21Lines changed: 52 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,33 +13,64 @@ Kubernetes projects require that you sign a Contributor License Agreement (CLA)
13
13
> See the [developer guide](https://cluster-api-aws.sigs.k8s.io/development/development.html) on how to setup your development environment.
14
14
5. Submit a pull request.
15
15
16
-
### Becoming a reviewer
16
+
### Contributer Ladder
17
17
18
-
If you would like to become a reviewer, then please ask one of the maintainers.
19
-
There's no hard and defined limit as to who can become a reviewer, but a good
20
-
heuristic is 5 or more contributions. A reviewer can get PRs automatically assigned
21
-
for review, and can `/lgtm` PRs.
18
+
We broadly follow the requirements from the [Kubernetes Community Membership](https://github.com/kubernetes/community/blob/master/community-membership.md).
22
19
23
-
To become a reviewer, ensure you are a member of the kubernetes-sigs Github organisation
24
-
following https://github.com/kubernetes/org/issues/new/choose .
20
+
> When making changes to **OWNER_ALIASES** please check that the **sig-cluster-lifecycle-leads**, **cluster-api-admins** and **cluster-api-maintainers** are correct.
25
21
26
-
### Steps needed to become a maintainer
27
-
If you have made significant contributions to Cluster API
28
-
Provider AWS, a maintainer may nominate you to become a
29
-
maintainer, first by opening a PR to add you to the OWNERS_ALIASES file of the repository.
22
+
#### Becoming a reviewer
30
23
31
-
Maintainers are able to approve PRs, as well as participate
32
-
in release processes.
24
+
If you would like to become a reviewer, then please ask one of the current maintainers.
33
25
34
-
Maintainers require membership of the Kubernetes Github organisation via
26
+
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 full meet the requirements then reach out to us, they are not set in stone.
27
+
28
+
A reviewer can get PRs automatically assigned for review, and can `/lgtm` PRs.
29
+
30
+
To become a reviewer, ensure you are a member of the **kubernetes-sigs** Github organisation
31
+
following https://github.com/kubernetes/org/issues/new/choose.
32
+
33
+
The steps to add someone as a reviewer are:
34
+
35
+
- Add the GitHub alias to the **cluster-api-aws-reviewers** section of [OWNERS_ALIASES](https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/OWNERS_ALIASES)
36
+
- Create a PR with the change that is held (i.e. by using `/hold`)
37
+
- Announce the change within the CAPA slack channel and as a PSA in the next CAPA office hours
38
+
- After 7 days of lazy consensus or after the next CAPA office hours (whichever is longer) the PR can be merged
39
+
40
+
#### Becoming a maintainer
41
+
42
+
If you have made significant contributions to Cluster API Provider AWS, a maintainer may nominate you to become a maintainer for the project.
43
+
44
+
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.
45
+
46
+
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 else wants to**.
47
+
48
+
Maintainers require membership of the **Kubernetes** Github organisation via
The complete list of tasks required to set up maintainer status
38
-
follow:
51
+
The steps to add someone as a reviewer are:
52
+
53
+
- Add the GitHub alias to the **cluster-api-aws-maintainers** and remove them from **cluster-api-aws-reviewers** sections of [OWNERS_ALIASES](https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/OWNERS_ALIASES)
54
+
- Create a PR with the change that is held (i.e. by using `/hold`)
55
+
- Announce the change within the CAPA slack channel and as a PSA in the next CAPA office hours
56
+
- After 7 days of lazy consensus or after the next CAPA office hours (whichever is longer) the PR can be merged
57
+
- Open PR to add Github username to **cluster-api-provider-aws-maintainers**
58
+
to https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml
59
+
- Open PR to add Github username to https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api-provider-aws/OWNERS
60
+
- Open PR to add Github username to https://github.com/kubernetes/k8s.io/blob/main/k8s.gcr.io/images/k8s-staging-cluster-api-aws/OWNERS
61
+
- Open PR to add Google ID to the [email protected] Google group in https://github.com/kubernetes/k8s.io/blob/main/groups/groups.yaml
62
+
63
+
#### Becoming a admin
64
+
65
+
After a period of time one of the existing CAPA or CAPI admins may propose you to become an admin of the CAPA project.
66
+
67
+
Admins have GitHub **admin** access to perform tasks on the repo.
68
+
69
+
The steps to add someone as an admin are:
39
70
40
-
* Open PR to add Github username to the OWNERS_ALIASES file under cluster-api-aws-maintainers
41
-
* Open PR to add Github username to cluster-api-provider-aws-admins and cluster-api-provider-aws-maintainers
71
+
- Add the GitHub alias to the **cluster-api-aws-admins** section of [OWNERS_ALIASES](https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/OWNERS_ALIASES)
72
+
- Create a PR with the change that is held (i.e. by using `/hold`)
73
+
- Announce the change within the CAPA slack channel and as a PSA in the next CAPA office hours
74
+
- After 7 days of lazy consensus or after the next CAPA office hours (whichever is longer) the PR can be merged
75
+
- Open PR to add Github username to **cluster-api-provider-aws-admins**
42
76
to https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml
43
-
* Open PR to add Github username to https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api-provider-aws/OWNERS
44
-
* Open PR to add Github username to https://github.com/kubernetes/k8s.io/blob/main/k8s.gcr.io/images/k8s-staging-cluster-api-aws/OWNERS
45
-
* Open PR to add Google ID to the [email protected] Google group in https://github.com/kubernetes/k8s.io/blob/main/groups/groups.yaml
(See [Kubernetes support matrix][cluster-api-supported-v] of Cluster API versions).
73
72
@@ -86,6 +85,7 @@ See [amis] for the list of most recently published AMIs.
86
85
`clusterawsadm` binaries are released with each release, can be found under [assets](https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases/latest) section.
87
86
88
87
------
88
+
89
89
## Getting involved and contributing
90
90
91
91
Are you interested in contributing to cluster-api-provider-aws? We, the
@@ -113,16 +113,13 @@ This repository uses the Kubernetes bots. See a full list of the commands [here
113
113
114
114
If you want to just build the CAPA containers locally, run
115
115
116
-
```
117
-
REGISTRY=docker.io/my-reg make docker-build
116
+
```shell
117
+
REGISTRY=docker.io/my-reg make docker-build
118
118
```
119
119
120
120
### Tilt-based development environment
121
121
122
-
See [development][development] section for details
0 commit comments