Skip to content
This repository has been archived by the owner on Dec 10, 2024. It is now read-only.

Commit

Permalink
Updating MAINTAINER file instructions based on TOC discussion
Browse files Browse the repository at this point in the history
Renamed 'MAINTAINERS-guidelines.md' to 'MAINTAINERS-file.md.
Replaced several LFDT GitHub organization adminstrators references with project TSC references.
Fixed broken links.

Signed-off-by: VRamakrishna <[email protected]>
  • Loading branch information
VRamakrishna committed Sep 12, 2024
1 parent c5fc6b3 commit 39e2926
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ nav_order: 2

All Linux Foundation Decentralized Trust (LFDT) repositories **MUST** have a `MAINTAINERS.md` file at the top-level directory of the source code. The [SAMPLE-MAINTAINERS.md](SAMPLE-MAINTAINERS.md) can be used as a template by projects creating a new repository.

The Technical Steering Committee (TSC) for the project to which a repository belongs **MUST** periodically send out notifications about missing `MAINTAINERS.md` files.

The LFDT GitHub organization administrators (i.e., LFDT TAC) **SHOULD** periodically send out notifications about missing `MAINTAINERS.md` files.

The following provides guidelines and suggested content to include in the `MAINTAINERS.md` file.
Expand All @@ -33,8 +35,8 @@ performed by the LFDT GitHub organization administrators.
In some repositories, the maintainers may decide to define additional scopes and
each Maintainer given one or more of those designated scopes:

- In rare cases, Maintainers in a repository may request that the LFDT TAC enable designating some Maintainers with different GitHub roles, such as "Admin" (more capable than "Maintain") or "Triage" (less capable than "Maintain").
- Each elevated GitHub role needed in a repository requires the LFDT GitHub organization administrators to create and maintain an additional GitHub Team.
- In rare cases, Maintainers in a repository may request that the project's TSC enable designating some Maintainers with different GitHub roles, such as "Admin" (more capable than "Maintain") or "Triage" (less capable than "Maintain").
- Each elevated GitHub role needed in a repository requires the project's TSC to create and maintain an additional GitHub Team.
- The LFDT TAC manages a team per LFDT Project that includes all contributors to the project. That team is given the "Read" GitHub role in all project repositories. This team need not be documented in the "MAINTAINERS" file.
- Maintainers **MAY** define Maintainer scopes within a repository that don't require
elevated GitHub privileges. For example, a scope might include hosting
Expand Down
2 changes: 1 addition & 1 deletion governing-documents/SAMPLE-MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The process to move a maintainer from active to emeritus status is comparable to
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 LFDT GitHub organization administrator (i.e., TAC).
- The PR is authored by, or has a comment supporting the proposal from, an existing maintainer or a member of the project's Technical Steering Commitee (TSC).
- 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:
Expand Down
2 changes: 1 addition & 1 deletion governing-documents/repository-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ format suffixes such as `.md`, `.rst`, or `.txt`.
- The current and important past releases
- Documentation for developers and users
- `MAINTAINERS` \
A list of all current maintainers with contact info. [A separate document](MAINTAINERS-guidelines.md)
A list of all current maintainers with contact info. [A separate document](MAINTAINERS-file.md)
covers the specifics.
- `CONTRIBUTING` \
Directions on how to contribute code to the project, or a pointer to the Wiki page with that information.
Expand Down
2 changes: 1 addition & 1 deletion guidelines/project-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The [Project Incubation Exit Criteria](../governing-documents/project-incubation
## Maintainer guidelines

* Projects should document maintainers along with maintainer roles and responsibilities in a `MAINTAINERS.md` file.
* See the [Maintainers Guidelines](../governing-documents/MAINTAINERS-guidelines.md) and [sample MAINTAINERS.md](../governing-documents/SAMPLE-MAINTAINERS.md) for suggested duties of a maintainer and guidance on how to add and remove maintainers.
* See the [Maintainers File Governing Document](../governing-documents/MAINTAINERS-file.md) and [sample MAINTAINERS.md](../governing-documents/SAMPLE-MAINTAINERS.md) for suggested duties of a maintainer and guidance on how to add and remove maintainers.

## Inclusive naming

Expand Down
2 changes: 1 addition & 1 deletion project-reports/0000-annual-review-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ nav_exclude: true
</mark>

# Maintainer Diversity
<mark>_How many maintainers do you have, and which organisations are they from? How has the maintainers and diversity of your maintainers changed in the past year? Has the number of active maintainers increased/decreased? Has the diversity of maintainers increased/decreased? Please include a link to your existing [MAINTAINERS file](../governing-documents/MAINTAINERS-guidelines.md) and the MAINTAINERS file from last year (if appropriate). This is a good opportunity to ensure that your MAINTAINERS file is up to date and to retire any maintainers._
<mark>_How many maintainers do you have, and which organisations are they from? How has the maintainers and diversity of your maintainers changed in the past year? Has the number of active maintainers increased/decreased? Has the diversity of maintainers increased/decreased? Please include a link to your existing [MAINTAINERS file](../governing-documents/MAINTAINERS-file.md) and the MAINTAINERS file from last year (if appropriate). This is a good opportunity to ensure that your MAINTAINERS file is up to date and to retire any maintainers._
</mark>

# Project Adoption
Expand Down
2 changes: 1 addition & 1 deletion project-reports/2024/2024-annual-Hyperledger-Aries.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Aries remains a healthy project and one of several viable candidates for major d

## Maintainer Diversity

_Guidance: How many maintainers do you have, and which organisations are they from? How has the maintainers and diversity of your maintainers changed in the past year? Has the number of active maintainers increased/decreased? Has the diversity of maintainers increased/decreased? Please include a link to your existing [MAINTAINERS file](https://github.com/hyperledger/toc/blob/gh-pages/governing-documents/MAINTAINERS-guidelines.md) and the MAINTAINERS file from last year (if appropriate). This is a good opportunity to ensure that your MAINTAINERS file is up to date and to retire any maintainers._
_Guidance: How many maintainers do you have, and which organisations are they from? How has the maintainers and diversity of your maintainers changed in the past year? Has the number of active maintainers increased/decreased? Has the diversity of maintainers increased/decreased? Please include a link to your existing [MAINTAINERS file](https://github.com/hyperledger/toc/blob/gh-pages/governing-documents/MAINTAINERS-file.md) and the MAINTAINERS file from last year (if appropriate). This is a good opportunity to ensure that your MAINTAINERS file is up to date and to retire any maintainers._

There are currently 62 people on the 48 Hyperledger Aries teams representing at least 19 organizations. As there are still dependent projects in Hyperledger, the Agent Framework JavaScript Maintainers continue to be Aries Maintainers, despite the move of the repository to the Open Wallet Foundation.

Expand Down

0 comments on commit 39e2926

Please sign in to comment.