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.

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

docs: updates triager role to reviewer role in contributor ladder #70

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: New triager nomination
description: Nomination for triager role for the community repository
title: 'Triager role for @'
name: New reviewer nomination
description: Nomination for reviewer role for the community repository
title: 'Reviewer role for @'
labels: ["nomination"]
assignees:
- community-maintainers
Expand Down
35 changes: 25 additions & 10 deletions MEMBERSHIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document outlines the various responsibilities of contributor roles in the OSCAL Compass organization. OSCAL Compass is made up of several projects that are defined as codebases and services with different release cycles, thus the responsibilities for roles are scope to individual projects. Where applicable for OSCAL Compass overall, contributor status is equal to the highest status that they have on any project.

This document outlines a core number of contributor roles for OSCAL Compass projects, such as _Member_, _Triager_, and _Maintainer_. An _Oversight Committee_ also serves to supervise the overall OSCAL Compass project and its health. Using transparent criteria, the journey between roles is based on individual participation. Criteria will be reevaluated periodically to ensure that we can meet the needs of each project with the resources available to contribute.
This document outlines a core number of contributor roles for OSCAL Compass projects, such as _Member_, _Reviewer_, and _Maintainer_. An _Oversight Committee_ also serves to supervise the overall OSCAL Compass project and its health. Using transparent criteria, the journey between roles is based on individual participation. Criteria will be reevaluated periodically to ensure that we can meet the needs of each project with the resources available to contribute.

OSCAL Compass welcomes new contributors. Not all contributors are able to provide sustained contribution, but each contribution is welcome. Established contributors are expected to demonstrate their adherence to the criteria in this document, familiarity with project organization, roles, policies, etc., and technical and/or writing ability. Role-specific expectations, responsibilities, and requirements are explained below.

Expand All @@ -13,8 +13,18 @@ The following table provides information about the current roles available to th
| Role | Responsibilities | Requirements | Defined by |
|------------|----------------------------------------------|---------------------------------------------------------------|-------------------------------|
| Member | Active contributor in the community | Multiple contributions and sponsored by 2 Maintainers | OSCAL Compass GitHub org member |
| Triager | Triaging issues and PRs | History of issue and PR triage and sponsored by 2 Maintainers | OSCAL Compass GitHub Triage team member |
| Maintainer | Sets direction and priorities for a project | Demonstrated responsibility and excellent technical judgement. Nominated and approved by Maintainers team. | `MAINTAINERS.md` file on project level |
| Reviewer | Reviews issues and PRs | History of issue triage and PR review and sponsored by 2 Maintainers | OSCAL Compass GitHub Reviewer team member |
| Maintainer | Sets direction and priorities for a project | Demonstrated responsibility and excellent technical judgement. Nominated and approved by Maintainers team. | OSCAL Compass GitHub Maintainer team member, [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners), and `MAINTAINERS.md` in each project |

### Team to GitHub Permissions

| Role | GitHub Permissions |
|------------|----------------------------------------------|
| Member | Read |
| Reviewer | Write with merging restricted via CODEOWNERS |
| Maintainer | Maintain |

> Note: Each project will require push restriction branch protection rule to allow only CODEOWNERS to push to default branches.

### Member

Expand Down Expand Up @@ -47,17 +57,19 @@ As a project Member, you have the following responsibilities and privileges:
* You provide code that consistently pass tests.
* You consistently address bugs or issues that are discovered after code has been accepted.

### Triager
### Reviewer

Triagers are active contributors in the community through issue and pull request triage. Triagers are expected to remain active in this task.
Reviewers are knowledgeable about both the codebase and are able review code for quality and correctness. They should expect issues and pull requests (PRs) to be assigned to them and respond per community expectations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "both"?


#### Triager requirements
#### Reviewer requirements

To become a project Triager, you must meet the following requirements:
To become a project Reviewer, you must meet the following requirements:

* You have made multiple contributions to the project or community. Contribution may include, but is not limited to:
* Triaging open issues or PRs.
* Authoring or reviewing PRs on GitHub.
* Demonstrating knowledge of the codebase
* Participating in design discussions.
* Contributing to community discussions (e.g. meetings, Slack).

* You have been sponsored by two Maintainers.
Expand All @@ -68,13 +80,16 @@ Any person who meets the requirements may be nominated by a contributor, includi
* Ensure that the sponsors are `@mentioned` on the issue.
* Make sure that the list of contributions included is representative of the work on the project.

#### Triager responsibilities and privileges
#### Reviewer responsibilities and privileges

As a project Triager, you have the following responsibilities and privileges:
As a project Reviewer, you have the following responsibilities and privileges:

* You have the permission to approve, but not merge, a PR.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can reviewer not merge a PR? Above in the permissions for Reviewer it is mentioned that they have write access with merging restricted via CODEOWNERS.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vikas-agarwal76 I think this could be reworded, but the reviewer could merge a PR (they would have write access), it would just need a maintainer approval first if "Require review from Code Owners" is set as a branch protection rule. Does this clarify? If so, I can alter the sections pertaining to this.

Copy link
Member Author

@jpower432 jpower432 Aug 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I refined the section to be more explicit about what would be restricted through CODEOWNERS

* You have permission to label issues and PRs.
* You consistently assign, close, and reopen issues or PRs.
* You actively triage issues and PRs with high quality.
* You will be assigned PRs to review in the project.
* You will be assigned issues to investigate in the project.

### Maintainer

Expand Down Expand Up @@ -105,7 +120,7 @@ As a project Maintainer, you have the following responsibilities and privileges:
* You make and approve technical design decisions.
* You set technical direction and priorities.
* You define milestones and releases.
* You mentor and guide contributors to the project, including mentoring and sponsoring potential Triager and Maintainer candidates.
* You mentor and guide contributors to the project, including mentoring and sponsoring potential Reviewer and Maintainer candidates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewer mentors Maintainer candidates?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is listed as a Maintainer responsibility. Existing maintainers mentor reviewer and maintainer candidates.

* You ensure the continued health of the project.
* You are responsive to review requests.
* You review assigned PRs that are related to your area of expertise.
Expand Down