-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
MAINTAINERS.md: add collaborators and organization members #2308
Conversation
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.
Thanks for tackling this :) I left some inline comments.
MAINTAINERS.md
Outdated
@@ -1,6 +1,22 @@ | |||
# Maintainers | |||
This file contains a list of the maintainers of tldr-pages. | |||
|
|||
|
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.
Why two blank lines?
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.
Ah, it's just habit I think. When I write markdown elsewhere I use a double blank line to delimit sections.
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.
Ok, but in that case please apply that pattern consistently throughout the file. I'd suggest two blank lines above section headings, and one below.
MAINTAINERS.md
Outdated
|
||
## Current collaborators | ||
The following people are collaborators on this repository, enabling them to label and close issues, | ||
and review and merge pull requests. |
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.
It would be nice to add the link to the automated list: https://github.com/tldr-pages/tldr/settings/collaboration
MAINTAINERS.md
Outdated
|
||
|
||
## Current members | ||
These people are members of the tldr-pages organization. |
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.
Link to https://github.com/orgs/tldr-pages/people here...
MAINTAINERS.md
Outdated
@@ -1,6 +1,22 @@ | |||
# Maintainers | |||
This file contains a list of the maintainers of tldr-pages. | |||
|
|||
|
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.
Ok, but in that case please apply that pattern consistently throughout the file. I'd suggest two blank lines above section headings, and one below.
MAINTAINERS.md
Outdated
|
||
|
||
## Current members | ||
These people are members of the tldr-pages organization. An automated list can |
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.
Please also mention what they can/should do, similarly to what you wrote in the previous section. Let me know if this information is not clear.
Ah, oops! I missed a bit, didn't I? Thanks for spotting that :P |
@sbrl are you planning to address this comment as well? Let me know if I can help. |
Ah, oops! I think it must have slipped through the net. Thanks for the reminder, @waldyrious :D |
MAINTAINERS.md
Outdated
@@ -16,7 +16,9 @@ can be found [here](https://github.com/tldr-pages/tldr/settings/collaboration). | |||
|
|||
## Current members | |||
|
|||
These people are members of the tldr-pages organization. An automated list can | |||
These people are members of the tldr-pages organization. As well as doing | |||
everything that a contributor can do, a member also has access to all the |
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.
Perhaps "a member also has write access", to make this clearer? Anyone can "access" (i.e. read) the 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.
LGTM, thanks again for taking this on!
Part of #2266.