docs: add MAINTAINING.md for maintainers guide #2663
Conversation
dhmlau
requested review from
b-admike,
bajtos,
hacksparrow,
jannyHou and
raymondfeng
as code owners
|
Should we also create |
|
@raymondfeng , similar to https://github.com/nodejs/node/blob/master/deps/uv/MAINTAINERS.md? Are you referring to adding another file or merge the 2 content into one file? |
|
Yes, as two separate files. |
|
Added the list of maintainers in the last commit. However, I have a question. Looking at the members in https://github.com/orgs/strongloop/teams/loopback-maintainers/members:
The description of this github team seems to meant to be for LB4 maintainers. @bajtos, maybe you have more info on that? Thanks. |
| take a look at issues and pull requests related to code you contributed | ||
| yourself. | ||
|
|
||
| ## More questions? |
There was a problem hiding this comment.
If someone has a question that isn't covered here, should we also include something like "If you have more questions, feel free to reach out by * insert way for them to reach us *"? Also, how do non-IBM maintainers communicate with the team outside GitHub issues/PRs?
There was a problem hiding this comment.
That's a good question! I guess the simplest way is to create a github issue. Another way is to email the maintainers (email might be found in some of our github profiles), but I'd rather not encouraging people to email us. :)
@strongloop/loopback-maintainers, any suggestions?
There was a problem hiding this comment.
@nabdelgadir, I've added the last "question" regarding your comment. Thanks!
There was a problem hiding this comment.
The questions section LGTM 👍
There was a problem hiding this comment.
FWIW, GitHub offers teams a place for private discussions, see e.g. here: https://github.com/orgs/strongloop/teams/loopback-maintainers/discussions
I am not sure how do notifications work for discussions, using GitHub issues may be a safer way.
| - Nora Abdelgadir ([@nabdelgadir](https://github.com/nabdelgadir)) | ||
| - Raymond Feng ([@raymondfeng](https://github.com/raymondfeng)) | ||
| - TN ([@thinusn](https://github.com/thinusn)) | ||
| - Yaapa Hage ([@hacksparrow](https://github.com/hacksparrow)) |
There was a problem hiding this comment.
Maybe we should divide the list into IBMers and community members. Or mark us as IBMers.
There was a problem hiding this comment.
How about core maintainers and community maintainers that are used somewhere else in the docs? e.g. https://loopback.io/doc/en/contrib/Governance.html.
docs/MAINTAINING.md
Outdated
| - Greater influence on LoopBack's future direction | ||
| - Commit (write) rights to `loopback-next` repo | ||
| - Ability to review and land pull requests, edit/categorize/close issues | ||
| - Access to a private Gitter room for LoopBack maintainers |
There was a problem hiding this comment.
Actually, I meant to remove it. Thanks for catching that.
| @@ -0,0 +1,21 @@ | |||
| ## Project Maintainers | |||
There was a problem hiding this comment.
This file seems to duplicate the content in our README, see https://github.com/strongloop/loopback-next#team
@dhmlau Please find a way how to have a single place listing the maintainers.
Add
MAINTAINING.mdfor maintainers' guide.Some of the contents are coming from the email content when we're inviting maintainers, regarding the benefits, expectation and responsibilities.
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated