Add Maintainers Guidelines #1
Conversation
Signed-off-by: Kuhrt, Tracy A <tracy.a.kuhrt@accenture.com>
Signed-off-by: Kuhrt, Tracy A <tracy.a.kuhrt@accenture.com>
| ## What Does Being a Maintainer Entail | ||
| The `MAINTAINERS.md` file SHOULD contain information about the different types of maintainers that exist (whole project, repo, part of repo) and what their duties are (e.g., maintainers calls, quarterly reports, code reviews, issue cleansing). | ||
|
|
||
| ## How to Become a Maintainer |
There was a problem hiding this comment.
I'm wondering whether we should allow for that info to be elsewhere and merely have a link to it in that case because several projects have that info in their docs today. On the other hand, the change this involves is simple and a link could be made the other way around...
There was a problem hiding this comment.
I was hoping the SHOULD gave that out.
There was a problem hiding this comment.
Yeah but the thing is that we do want to be able to get to that info from the MAINTAINERS file. This is often not the case today. So I think adding something stating that this needs to be in the file or linked from it would give better results.
There was a problem hiding this comment.
We should discuss with rest of @hyperledger/tsc. I was trying to not be too prescriptive with the guidelines.
There was a problem hiding this comment.
I'm sympathetic to Tracy's POV here
Signed-off-by: Kuhrt, Tracy A <tracy.a.kuhrt@accenture.com>
Signed-off-by: Kuhrt, Tracy A <tracy.a.kuhrt@accenture.com>
|
Looks good to me. Thanks Tracy! |
| ## List of Project Maintainers | ||
| The first thing that MUST be included in the `MAINTAINERS` file is a list of the project's maintainers, both active and emeritus. | ||
|
|
||
| It is recommended that the lists be sorted alphabetically and contain the maintainers name, GitHub ID, LFID, Chat ID, Email, Company Affiliation, and Scope. |
There was a problem hiding this comment.
Is it clear that we recommend at least those fields and that it is not forbidden to add other fields?
There was a problem hiding this comment.
This is only a recommended list of fields. Do you have a suggestion on re-wording?
| * There MUST be at least one reliable mechanism to contact the maintainer (either chat ID or email). | ||
| * Scope is dependent on the project and may not exist for a given project. Scope could be the whole project, a specific repository, specific directories in a repository, or high-level description of responsibility (e.g., Documentation). | ||
|
|
||
| The following shows the suggested format for the information: |
There was a problem hiding this comment.
I would like to make sure that the maintainers fell free to choose the format they prefer especially if they plan to use GitHub hooks as David was suggesting during the TSC call.
There was a problem hiding this comment.
Agree. That is why it is a "suggested format"
|
I think you have the approvals needed for merge |
Signed-off-by: Kuhrt, Tracy A <tracy.a.kuhrt@accenture.com>
Signed-off-by: Kuhrt, Tracy A tracy.a.kuhrt@accenture.com