Skip to content

Commit

Permalink
Update the maintainers file to reflect the mechanics of the process
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Curran <[email protected]>
  • Loading branch information
swcurran committed Sep 25, 2024
1 parent e3ab448 commit 4912b6b
Showing 1 changed file with 31 additions and 61 deletions.
92 changes: 31 additions & 61 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,14 @@

## Maintainer Scopes, GitHub Roles and GitHub Teams

Maintainers are assigned the following scopes in this repository:

| Scope | Definition | GitHub Role | GitHub Team |
| ---------- | ------------------------ | ----------- | ------------------------------------ |
| Admin | | Admin | [aries-admins] |
| Maintainer | The GitHub Maintain role | Maintain | [aries-cloudagent-python committers] |
| Triage | The GitHub Triage role | Triage | [aries triage] |
| Read | The GitHub Read role | Read | [Aries Contributors] |
| Read | The GitHub Read role | Read | [TOC] |
| Read | The GitHub Read role | Read | [aries-framework-go-ext committers] |

[aries-admins]: https://github.com/orgs/hyperledger/teams/aries-admins
[aries-cloudagent-python committers]: https://github.com/orgs/hyperledger/teams/aries-cloudagent-python-committers
[aries triage]: https://github.com/orgs/hyperledger/teams/aries-triage
[Aries Contributors]: https://github.com/orgs/hyperledger/teams/aries-contributors
[TOC]: https://github.com/orgs/hyperledger/teams/toc
[aries-framework-go-ext committers]: https://github.com/orgs/hyperledger/teams/aries-framework-go-ext-committers

## Active Maintainers

<!-- Please keep this sorted alphabetically by github -->

| GitHub ID | Name | Scope | LFID | Discord ID | Email | Company Affiliation |
| --------------- | ---------------- | ---------- | ---- | ---------- | ------------------------ | ------------------- |
| andrewwhitehead | Andrew Whitehead | Admin | | | [email protected] | BC Gov |
| dbluhm | Daniel Bluhm | Admin | | | [email protected] | Indicio PBC |
| dhh1128 | Daniel Hardman | Admin | | | [email protected] | Provident |
| shaangill025 | Shaanjot Gill | Maintainer | | | [email protected] | BC Gov |
| swcurran | Stephen Curran | Admin | | | [email protected] | BC Gov |
| TelegramSam | Sam Curren | Maintainer | | | [email protected] | Indicio PBC |
| TimoGlastra | Timo Glastra | Admin | | | [email protected] | Animo Solutions |
| WadeBarnes | Wade Barnes | Admin | | | [email protected] | BC Gov |
| usingtechnology | Jason Sherman | Maintainer | | | [email protected] | BC Gov |

## Emeritus Maintainers

| Name | GitHub ID | Scope | LFID | Discord ID | Email | Company Affiliation |
|----- | --------- | ----- | ---- | ---------- | ----- | ------------------- |
| | | | | | | |
The Maintainers of this repo, defined as GitHub users with escalated privileges
in the repo, are managed in the Hyperledger "governance" repo's [access-control.yaml](https://github.com/hyperledger/governance/blob/main/access-control.yaml) file. Consult that to see:

- What teams have escalated privileges to this repository.
- What GitHub roles those teams have in the repository.
- Who are the members of each of those teams.

The actions covered below for [becoming](#becoming-a-maintainer) and [removing](#removing-maintainers) are made manifest through PRs to that file.

## The Duties of a Maintainer

Expand Down Expand Up @@ -74,18 +43,18 @@ occur, roughly in order.
- The proposed maintainer establishes their reputation in the community,
including authoring five (5) significant merged pull requests, and expresses
an interest in becoming a maintainer for the repository.
- A PR is created to update this file to add the proposed maintainer to the list of active maintainers.
- The PR is authored by an existing maintainer or has a comment on the PR from an existing maintainer supporting the proposal.
- The PR is authored by the proposed maintainer or has a comment on the PR from the proposed maintainer confirming their interest in being a maintainer.
- The PR or comment from the proposed maintainer must include their
- An issue is created to add the proposed maintainer to the list of active maintainers.
- The issue is authored by an existing maintainer or has a comment on the PR from an existing maintainer supporting the proposal.
- The issue is authored by the proposed maintainer or has a comment on the issue from the proposed maintainer confirming their interest in being a maintainer.
- The issue or comment from the proposed maintainer must include their
willingness to be a long-term (more than 6 month) maintainer.
- Once the PR and necessary comments have been received, an approval timeframe begins.
- The PR **MUST** be communicated on all appropriate communication channels, including relevant community calls, chat channels and mailing lists. Comments of support from the community are welcome.
- The PR is merged and the proposed maintainer becomes a maintainer if either:
- Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
- An absolute majority of maintainers have approved the PR.
- If the PR does not get the requisite PR approvals, it may be closed.
- Once the add maintainer PR has been merged, any necessary updates to the GitHub Teams are made.
- Once the issue and necessary comments have been received, an approval timeframe begins.
- The issue **MUST** be communicated on all appropriate communication channels, including relevant community calls, chat channels and mailing lists. Comments of support from the community are welcome.
- The issue is approved and the proposed maintainer becomes a maintainer if either:
- Two weeks have passed since at least three (3) Maintainer issue approvals have been recorded, OR
- An absolute majority of maintainers have approved the issue.
- If the issue does not get the requisite approvals, it may be closed.
- Once the add maintainer issue has been approved, the necessary updates to the GitHub Teams are made via a PR to the Hyperledger "governance" repo's [access-control.yaml](https://github.com/hyperledger/governance/blob/main/access-control.yaml) file.

## Removing Maintainers

Expand All @@ -104,17 +73,18 @@ maintainer to emeritus status. This can occur in the following situations:
- Other circumstances at the discretion of the other Maintainers.

The process to move a maintainer from active to emeritus status is comparable to the process for adding a maintainer, outlined above. In the case of voluntary
resignation, the Pull Request can be merged following a maintainer PR approval. If the removal is for any other reason, the following steps **SHOULD** be followed:

- A PR is created to update this file to move the maintainer to the list of emeritus maintainers.
- The PR is authored by, or has a comment supporting the proposal from, an existing maintainer or Hyperledger GitHub organization administrator.
- Once the PR and necessary comments have been received, the approval timeframe begins.
- The PR **MAY** be communicated on appropriate communication channels, including relevant community calls, chat channels and mailing lists.
- The PR is merged and the maintainer transitions to maintainer emeritus if:
- The PR is approved by the maintainer to be transitioned, OR
- Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
- An absolute majority of maintainers have approved the PR.
- If the PR does not get the requisite PR approvals, it may be closed.
resignation, the Pull Request can be merged following a maintainer issue approval. If the removal is for any other reason, the following steps **SHOULD** be followed:

- An issue is created to move the maintainer to the list of emeritus maintainers.
- The issue is authored by, or has a comment supporting the proposal from, an existing maintainer or Hyperledger GitHub organization administrator.
- Once the issue and necessary comments have been received, the approval timeframe begins.
- The issue **MAY** be communicated on appropriate communication channels, including relevant community calls, chat channels and mailing lists.
- The issue is approved and the maintainer transitions to maintainer emeritus if:
- The issue is approved by the maintainer to be transitioned, OR
- Two weeks have passed since at least three (3) Maintainer issue approvals have been recorded, OR
- An absolute majority of maintainers have approved the issue.
- If the issue does not get the requisite approvals, it may be closed.
- Once the remove maintainer issue has been approved, the necessary updates to the GitHub Teams are made via a PR to the Hyperledger "governance" repo's [access-control.yaml](https://github.com/hyperledger/governance/blob/main/access-control.yaml) file.

Returning to active status from emeritus status uses the same steps as adding a
new maintainer. Note that the emeritus maintainer already has the 5 required
Expand Down

0 comments on commit 4912b6b

Please sign in to comment.