-
Notifications
You must be signed in to change notification settings - Fork 22
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
Add the MAINTANERS.md. #190
Add the MAINTANERS.md. #190
Conversation
Some questions:
|
22ab69f
to
98d676d
Compare
/assign @qiujian16 |
9fd495d
to
16931c4
Compare
16931c4
to
fd125eb
Compare
MAINTAINERS.md
Outdated
* [clusteradm](https://github.com/open-cluster-management-io/clusteradm) | ||
* Jian Qiu | ||
|
||
### Integrations and Offical support Addons |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Integrations and Addons should be good enough
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed.
* Zhiwei Yin | ||
* Jian Zhu | ||
* [sdk-go](https://github.com/open-cluster-management-io/sdk-go/blob/main/OWNERS) | ||
* Jian Qiu |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we cannot have only one maintainer for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another name in OWNERS file is David, added in here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But I wondor whether David want to do review work of this sdk-go repo, as someone from community may throw PRs and questions to him because his name is under this repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we might need to tweak the sdk-go owner file
Could we have the format of: name, company, [list of repos] to eliminate duplicated contents? |
fd125eb
to
a674910
Compare
@mikeshng That way we may end with duplicated list of repos. And I'm not sure whether we want to keep the [overall list] and [maintainers in different areas] in a same page. For example, in prometheus, it's sperated:
After we add all maintainers in the list, we shoult have toc to take a reivew |
MAINTAINERS.md
Outdated
* Zhu Jian | ||
|
||
### Integrations and Addons | ||
* [multicluster-controlplane](https://github.com/open-cluster-management-io/multicluster-controlplane) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about add a note here to clearify the different level of maintainibility? @qiujian16
Note: We welcome all community contributors to develop their addons in or out of the ocm-io and link them here.
The maintainers of integrations and addons only need to be responsible for their own repos.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, I think it is ok.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@qiujian16 The Integrations and Addons part is removed, added a "Note" to describe, and also link the "Integrations and Addons" section of website. Please take another look, thanks!
6e94194
to
57b33bb
Compare
Should we add the community repo? It's one of our pinned repos. |
57b33bb
to
725cd09
Compare
Good point, a new section of "Community and Docs" added. |
Signed-off-by: GitHub <[email protected]>
725cd09
to
c9e85bb
Compare
tamalsaha is added as the PR is going to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiujian16, xuezhaojun The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
1e5f27e
into
open-cluster-management-io:main
After the PR is merged, we should also update information in cncf repo: https://github.com/cncf/foundation/blob/2a58de4421a73db2c72f4ebe0795d8533ad1901e/project-maintainers.csv?plain=1#L1004
The motivation
The 2 options we have, and Pros and Cons
After going throught the graduated projects of cncf, we have found 2 pattern of MAINTAINER list.
Type1, json or yaml format, IaC, configuration style file
For examples:
Usually, the project's infrustructure team will setup a bot or ci tool to sync these teams configuration to github teams, then each repo under the org can leverage github teams to create the codeowners file.
Using cilium for an example:
The Pros are:
The Cons are:
Type2, markdown format, human read friendly, document style file
For examples:
Obviously, it's much easier to setup but it's not suitable when we have a lot of sub projects or work groups or teams.
The path
We will first add a type 2 MAINTAINER.md, in this step, we will discuss and figure out what teams and work-group we need to create.
Next, when we have enough members and maintainers we will invest the more automatic way -- to create a type 1 MAINTAINER list, we may even can recurit from the community.