-
Notifications
You must be signed in to change notification settings - Fork 517
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2258 from swcurran/fix-maintainers-file
Updating Maintainers list to be accurate and using the TOC format
- Loading branch information
Showing
1 changed file
with
91 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,120 @@ | ||
| # Maintainers | ||
|
|
||
| ## 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 --> | ||
|
|
||
| | Name | Github | LFID | | ||
| | ---------------- | ---------------- | ---------------- | | ||
| | Sam Curren | TelegramSam | TelegramSam | | ||
| | Stephen Curran | swcurran | swcurran | | ||
| | Andrew Whitehead | andrewwhitehead | cywolf | | ||
| | 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 | | ||
| | dh1128 | 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 | | ||
|
|
||
| ## Emeritus Maintainers | ||
|
|
||
| | Name | Github | LFID | | ||
| |--------------|---------|---------| | ||
| | | | | | ||
| | Name | GitHub ID | Scope | LFID | Discord ID | Email | Company Affiliation | | ||
| |----- | --------- | ----- | ---- | ---------- | ----- | ------------------- | | ||
| | | | | | | | | | ||
|
|
||
| ## The Duties of a Maintainer | ||
|
|
||
| Maintainers are expected to perform the following duties for this repository. The duties are listed in more or less priority order: | ||
|
|
||
| - Review, respond, and act on any security vulnerabilities reported against the repository. | ||
| - Review, provide feedback on, and merge or reject GitHub Pull Requests from | ||
| Contributors. | ||
| - Review, triage, comment on, and close GitHub Issues | ||
| submitted by Contributors. | ||
| - When appropriate, lead/facilitate architectural discussions in the community. | ||
| - When appropriate, lead/facilitate the creation of a product roadmap. | ||
| - Create, clarify, and label issues to be worked on by Contributors. | ||
| - Ensure that there is a well defined (and ideally automated) product test and | ||
| release pipeline, including the publication of release artifacts. | ||
| - When appropriate, execute the product release process. | ||
| - Maintain the repository CONTRIBUTING.md file and getting started documents to | ||
| give guidance and encouragement to those wanting to contribute to the product, and those wanting to become maintainers. | ||
| - Contribute to the product via GitHub Pull Requests. | ||
| - Monitor requests from the Hyperledger Technical Oversight Committee about the | ||
| contents and management of Hyperledger repositories, such as branch handling, | ||
| required files in repositories and so on. | ||
| - Contribute to the Hyperledger Project's Quarterly Report. | ||
|
|
||
| ## Becoming a Maintainer | ||
|
|
||
| The Aries Cloud Agent community welcomes contributions. Contributors may progress to become a | ||
| maintainer. To become a maintainer the following steps occur, roughly in order. | ||
|
|
||
| - 5 significant changes have been authored by the proposed maintainer and | ||
| accepted. | ||
| - The proposed maintainer has the sponsorship of at least one other maintainer. | ||
| - This sponsoring maintainer will create a PR modifying the list of | ||
| maintainers. | ||
| - The proposed maintainer accepts the nomination and expresses a willingness | ||
| to be a long-term (more than 6 month) committer. | ||
| - This would be a comment in the above PR. | ||
| - This PR will be communicated in all appropriate communication channels. It | ||
| should be mentioned in any maintainer/community call. It should also be | ||
| posted to the appropriate mailing list or chat channels if they exist. | ||
| - Approval by at least 3 current maintainers within two weeks of the proposal or | ||
| an absolute majority of current maintainers. | ||
| - These votes will be recorded in the PR modifying the list of maintainers. | ||
| - No veto by another maintainer within two weeks of proposal are recorded. | ||
| - All vetoes must be accompanied by a public explanation as a comment in the | ||
| PR for adding this maintainer | ||
| - The explanation of the veto must be reasonable. | ||
| - A veto can be retracted, in that case the approval/veto timeframe is reset. | ||
| - It is bad form to veto, retract, and veto again. | ||
| - The proposed maintainer becomes a maintainer | ||
| - Either two weeks have passed since the third approval, | ||
| - Or an absolute majority of maintainers approve. | ||
| - In either case, no maintainer presents a veto. | ||
| This community welcomes contributions. Interested contributors are encouraged to | ||
| progress to become maintainers. To become a maintainer the following steps | ||
| 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 | ||
| 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. | ||
|
|
||
| ## Removing Maintainers | ||
|
|
||
| Being a maintainer is not a status symbol or a title to be maintained | ||
| Being a maintainer is not a status symbol or a title to be carried | ||
| indefinitely. It will occasionally be necessary and appropriate to move a | ||
| maintainer to emeritus status. This can occur in the following situations: | ||
|
|
||
| - Resignation of a maintainer. | ||
| - Violation of the Code of Conduct warranting removal. | ||
| - Inactivity. | ||
| - A general measure of inactivity will be no commits or code review comments | ||
| for one reporting quarter, although this will not be strictly enforced if | ||
| for one reporting quarter. This will not be strictly enforced if | ||
| the maintainer expresses a reasonable intent to continue contributing. | ||
| - Reasonable exceptions to inactivity will be granted for known long term | ||
| leave such as parental leave and medical leave. | ||
| - Other unspecified circumstances. | ||
| - 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: | ||
|
|
||
| Like adding a maintainer the record and governance process for moving a | ||
| maintainer to emeritus status is recorded in the github PR making that change. | ||
| - 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. | ||
|
|
||
| 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 | ||
| significant changes as there is no contribution time horizon for those. | ||
| significant changes as there is no contribution time horizon for those. |