Skip to content

Commit 65ec680

Browse files
committed
More precise description of reviewers teams
1 parent 7ae9e1c commit 65ec680

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

toc/rfc/rfc-formal-aspiring-approvers-as-reviewers.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,40 @@
22
[meta]: #meta
33
- Name: Formally track aspiring approvers as reviewers
44
- Start Date: 2022-07-05
5-
- Author(s): @rkoster
5+
- Author(s): @rkoster, @stephanme
66
- Status: Draft <!-- Acceptable values: Draft, Approved, On Hold, Superseded -->
77
- RFC Pull Request: https://github.com/cloudfoundry/community/pull/333
88

99

1010
## Summary
1111

12-
Extend the working group yaml defenitions to optionally include a `reviewers` key with a list of contributors who like to become approvers.
12+
Extend the working group yaml definitions to optionally include a `reviewers` key per area with a list of contributors who like to become approvers.
1313
The github org automation should use this information to create a github team for the area with `-reviewers` suffix and __read__ permissions.
1414

15-
This will later allow automatic assignment of PRs to be reviewed, which will help these contributors more easily statisfy the requirments to become approvers.
15+
This will later allow automatic assignment of PRs to be reviewed, which will help these contributors more easily satisfy the requirements to become approvers. An additional use case might be granting read access to non-public CI pipelines.
1616

1717
## Problem
1818

1919
Due to the way to cloudfoundy github organization is setup, contributors gain no additional access rights within the organization.
2020
This prevents PRs to be assigned to them to be reviewed.
2121

22-
In addition, the current process for getting people approver status relies a lot on the decipline of contributors to rack up the [needed contribution points](https://github.com/cloudfoundry/community/blob/main/toc/rfc/rfc-0006-approver-requirements.md).
22+
In addition, the current process for getting people approver status relies a lot on the discipline of contributors to rack up the [needed contribution points](https://github.com/cloudfoundry/community/blob/main/toc/rfc/rfc-0006-approver-requirements.md).
2323
Ideally we create an opt-in low resistance path, to help contributors get to approver status quicker.
2424
A lack of enough approvers hinders our ability as a community to review and approve PRs in a timely manner.
2525
Improving the number of approvers should be the top priority of working group leads.
2626

2727
## Proposal
2828

29-
Allow tracking aspiring approvers as `reviewers` per working group area. Create a `*-reviewers` team per area with read access to the area's repos.
29+
Allow tracking aspiring approvers as `reviewers` per working group area. Create a `*-reviewers` team per area that includes a `reviewers` key with read access to the area's repos.
3030

31+
This extends [RFC-005 Standardizing Github Teams and Access](https://github.com/cloudfoundry/community/blob/main/toc/rfc/rfc-0005-github-teams-and-access.md):
3132

33+
| Name of Team | Team Membership | Permissions |
34+
|---|---|---|
35+
| wg-[WORKING-GROUP-NAME]-[AREA-NAME]-reviewers | Contributors who want to become approver for an area within a WG | Read access for all repos in the area, so that PRs can be assigned for review |
36+
37+
`reviewers` are not included in the overall working group team `wg-[WORKING-GROUP-NAME]`.
38+
39+
Where:
40+
* `WORKING-GROUP-NAME` is the name of the Working Group, converted to kebab case,
41+
* `AREA-NAME` is the name of the area, also converted to kebab case, or a suitable short name that identifies it clearly and uniquely within the Working Group.

0 commit comments

Comments
 (0)