Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PROPOSAL: Maintainers and reviewer changes #3775

Merged
merged 1 commit into from
Oct 19, 2022
Merged

PROPOSAL: Maintainers and reviewer changes #3775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 52 additions & 21 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,64 @@ Kubernetes projects require that you sign a Contributor License Agreement (CLA)
> See the [developer guide](https://cluster-api-aws.sigs.k8s.io/development/development.html) on how to setup your development environment.
5. Submit a pull request.

### Becoming a reviewer
### Contributer Ladder

If you would like to become a reviewer, then please ask one of the maintainers.
There's no hard and defined limit as to who can become a reviewer, but a good
heuristic is 5 or more contributions. A reviewer can get PRs automatically assigned
for review, and can `/lgtm` PRs.
We broadly follow the requirements from the [Kubernetes Community Membership](https://github.com/kubernetes/community/blob/master/community-membership.md).

To become a reviewer, ensure you are a member of the kubernetes-sigs Github organisation
following https://github.com/kubernetes/org/issues/new/choose .
> When making changes to **OWNER_ALIASES** please check that the **sig-cluster-lifecycle-leads**, **cluster-api-admins** and **cluster-api-maintainers** are correct.

### Steps needed to become a maintainer
If you have made significant contributions to Cluster API
Provider AWS, a maintainer may nominate you to become a
maintainer, first by opening a PR to add you to the OWNERS_ALIASES file of the repository.
#### Becoming a reviewer

Maintainers are able to approve PRs, as well as participate
in release processes.
If you would like to become a reviewer, then please ask one of the current maintainers.

Maintainers require membership of the Kubernetes Github organisation via
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.

A reviewer can get PRs automatically assigned for review, and can `/lgtm` PRs.

To become a reviewer, ensure you are a member of the **kubernetes-sigs** Github organisation
following https://github.com/kubernetes/org/issues/new/choose.

The steps to add someone as a reviewer are:

- 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)
- Create a PR with the change that is held (i.e. by using `/hold`)
- Announce the change within the CAPA slack channel and as a PSA in the next CAPA office hours
- After 7 days of lazy consensus or after the next CAPA office hours (whichever is longer) the PR can be merged

#### Becoming a maintainer

If you have made significant contributions to Cluster API Provider AWS, a maintainer may nominate you to become a maintainer for the project.

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.

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**.

Maintainers require membership of the **Kubernetes** Github organisation via
https://github.com/kubernetes/org/issues/new/choose

The complete list of tasks required to set up maintainer status
follow:
The steps to add someone as a reviewer are:

- 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)
- Create a PR with the change that is held (i.e. by using `/hold`)
- Announce the change within the CAPA slack channel and as a PSA in the next CAPA office hours
- After 7 days of lazy consensus or after the next CAPA office hours (whichever is longer) the PR can be merged
- Open PR to add Github username to **cluster-api-provider-aws-maintainers**
to https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml
- Open PR to add Github username to https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api-provider-aws/OWNERS
- 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
- Open PR to add Google ID to the k8s-infra-staging-cluster-api-aws@kubernetes.io Google group in https://github.com/kubernetes/k8s.io/blob/main/groups/groups.yaml

#### Becoming a admin

After a period of time one of the existing CAPA or CAPI admins may propose you to become an admin of the CAPA project.

Admins have GitHub **admin** access to perform tasks on the repo.

The steps to add someone as an admin are:

* Open PR to add Github username to the OWNERS_ALIASES file under cluster-api-aws-maintainers
* Open PR to add Github username to cluster-api-provider-aws-admins and cluster-api-provider-aws-maintainers
- 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)
- Create a PR with the change that is held (i.e. by using `/hold`)
- Announce the change within the CAPA slack channel and as a PSA in the next CAPA office hours
- After 7 days of lazy consensus or after the next CAPA office hours (whichever is longer) the PR can be merged
- Open PR to add Github username to **cluster-api-provider-aws-admins**
to https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml
* Open PR to add Github username to https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/cluster-api-provider-aws/OWNERS
* 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
* Open PR to add Google ID to the k8s-infra-staging-cluster-api-aws@kubernetes.io Google group in https://github.com/kubernetes/k8s.io/blob/main/groups/groups.yaml
2 changes: 2 additions & 0 deletions OWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ approvers:
- sig-cluster-lifecycle-leads
- cluster-api-admins
- cluster-api-maintainers
- cluster-api-aws-admins
- cluster-api-aws-maintainers

reviewers:
- cluster-api-aws-admins
- cluster-api-aws-maintainers
- cluster-api-aws-reviewers

Expand Down
18 changes: 12 additions & 6 deletions OWNERS_ALIASES
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
# See the OWNERS docs: https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md

aliases:
# Correct as of 2022/01/05
# Correct as of 2022/10/13
sig-cluster-lifecycle-leads:
- fabriziopandini
- justinsb
- neolit123
- vincepri
# Correct as of 2022/01/05
- timothysc
# Correct as of 2022/10/13
cluster-api-admins:
- CecileRobertMichon
- vincepri
# Correct as of 2022/01/05
# Correct as of 2022/10/13
cluster-api-maintainers:
- CecileRobertMichon
- enxebre
- fabriziopandini
- sbueringer
- vincepri
# Correct as of 2022/10/19
cluster-api-aws-admins:
- richardcase
- sedefsavas
cluster-api-aws-maintainers:
- richardcase
- sedefsavas
cluster-api-aws-reviewers:
- Skarlso
- Ankitasw
cluster-api-aws-reviewers:
- dthorsen
- dlipovetsky
- pydctw
- shivi28
- Skarlso
- AverageMarcus
42 changes: 18 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,11 @@ cluster on AWS.
This provider's versions are compatible with the following versions of Cluster API
and support all Kubernetes versions that is supported by its compatible Cluster API version:

| | Cluster API v1alpha3 (v0.3) | Cluster API v1alpha4 (v0.4) | Cluster API v1beta1 (v1.x) |
| --------------------------- | :-------------------------: | :-------------------------: | :-------------------------: |
| CAPA v1alpha3 `(v0.6)` | ✓ | ☓ | ☓ |
| CAPA v1alpha4 `(v0.7)` | ☓ | ✓ | ☓ |
| CAPA v1beta1 `(v1.x, main)`| ☓ | ☓ | ✓ |

| | Cluster API v1alpha4 (v0.4) | Cluster API v1beta1 (v1.x) |
| --------------------------- | :-------------------------: | :-------------------------: |
| CAPA v1alpha4 `(v0.7)` | ✓ | ☓ |
| CAPA v1beta1 `(v1.x)` | ☓ | ✓ |
| CAPA v1beta2 `(v2.x, main)`| ☓ | ✓ |

(See [Kubernetes support matrix][cluster-api-supported-v] of Cluster API versions).

Expand All @@ -86,6 +85,7 @@ See [amis] for the list of most recently published AMIs.
`clusterawsadm` binaries are released with each release, can be found under [assets](https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases/latest) section.

------

## Getting involved and contributing

Are you interested in contributing to cluster-api-provider-aws? We, the
Expand Down Expand Up @@ -113,16 +113,13 @@ This repository uses the Kubernetes bots. See a full list of the commands [here

If you want to just build the CAPA containers locally, run

```
REGISTRY=docker.io/my-reg make docker-build
```shell
REGISTRY=docker.io/my-reg make docker-build
```

### Tilt-based development environment

See [development][development] section for details

[development]: https://cluster-api-aws.sigs.k8s.io/development/development.html

See [development][development] section for details.

### Implementer office hours

Expand Down Expand Up @@ -172,16 +169,15 @@ and/or other countries."

Thank you to all contributors and a special thanks to our current maintainers & reviewers:

| Maintainers | Reviewers |
| ------------------------------------------------- | ---------------------------------------------- |
| [@richardcase](https://github.com/richardcase) | [@Ankitasw](https://github.com/Ankitasw) |
| [@sedefsavas](https://github.com/sedefsavas) | [@dthorsen](https://github.com/dthorsen) |
| | [@dlipovetsky](https://github.com/dlipovetsky) |
| | [@pydctw](https://github.com/pydctw) |
| | [@shivi28](https://github.com/shivi28) |
| | [@Skarlso](https://github.com/Skarlso) |
| Maintainers | Reviewers |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [@richardcase](https://github.com/richardcase) (from 2020-12-04) | [@shivi28](https://github.com/shivi28) (from 2021-08-27) |
| [@sedefsavas](https://github.com/sedefsavas) (from 2021-03-21) | [@dthorsen](https://github.com/dthorsen) (from 2020-12-04) |
| [@Skarlso](https://github.com/Skarlso) (from 2022-10-19) | [@dlipovetsky](https://github.com/dlipovetsky) (from 2021-08-27) |
| [@Ankitasw](https://github.com/Ankitasw) (from 2022-10-19) | [@pydctw](https://github.com/pydctw) (from 2021-12-09) |
| | [@AverageMarcus](https://github.com/AverageMarcus) (from 2022-10-19) |

and the previous/emeritus maintainers & reviwers:
and the previous/emeritus maintainers & reviewers:

| Emeritus Maintainers | Emeritus Reviewers |
| ---------------------------------------------------- | ------------------------------------------------------ |
Expand All @@ -200,7 +196,6 @@ All the CAPA contributors:
</a>
</p>


<!-- References -->
[slack]: https://kubernetes.slack.com/messages/CD6U2V71N
[good_first_issue]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22
Expand All @@ -210,9 +205,8 @@ All the CAPA contributors:
[cluster_api]: https://github.com/kubernetes-sigs/cluster-api
[kops]: https://github.com/kubernetes/kops
[kubicorn]: http://kubicorn.io/
[tilt]: https://tilt.dev
[cluster_api_tilt]: https://master.cluster-api.sigs.k8s.io/developer/tilt.html
[amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/amis.html
[published_amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/built-amis.html
[eks_support]: https://cluster-api-aws.sigs.k8s.io/topics/eks/index.html
[cluster-api-supported-v]: https://cluster-api.sigs.k8s.io/reference/versions.html
[development]: https://cluster-api-aws.sigs.k8s.io/development/development.html