-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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
doc: clarify triager role #55775
doc: clarify triager role #55775
Conversation
Review requested:
|
doc/contributing/issues.md
Outdated
@@ -60,5 +60,12 @@ activities, such as applying labels and closing/reopening/assigning issues. | |||
For more information on the roles and permissions, see ["Permission levels for | |||
repositories owned by an organization"](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization). | |||
|
|||
triagers are requested to abstain from below actions: | |||
* approve or request changes to a pull request |
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.
I don't think it is appropriate to ask triagers abstain from request changes to a pull request. Any contributors are welcomed to give reviews on a pull request. It's just that only collaborators can effectively block a pull request from landing (but a clear reason is still required anyway).
My feeling is that given the additional permissions as a triager, a triager should be sticking to the project standard, like the guide for collaborators:
- Welcoming first-time contributors/issue posters
- Where this is unclear, leave the issue or pull request open for several days to allow for discussion.
- Most importantly, be friendly.
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.
GH docs shows two different actions separately:
- submit reviews on PRs
- approve or request change to PRs
while anyone is free to review PRs, approval and request change is better reserved to committers, lest it can confuse contributors (especially new comers)?
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.
I can see how that'd be true for folks who have write permission on the repo but are not collaborators. I'm not sure I understand how that'd apply to triaggers. For triaggers who are collaborators: why would we be asking them to refrain? For triaggers who not collaborators: why would it different from other non-collaborator contributors?
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.
I think the clarification should focus on the new priviledges granted with the role and responsibility of the role. Like in the collaborator guide, the new priviledges are "writing to the repo". And in terms of the triager role, it is "managing the issues".
"Request a change" is not a new priviledge granted as a triger. Anyone, non-collaborators, can request change with the GitHub UI. And GitHub UI distinguishes effectiveness of a change request with red icons or grey icons.
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.
that is where the problem I guess. you both raise valid points. however when looking from the author point of view, they could get confused when a request change coming from a triager and perceive it as different (and more enforcing) than that from a normal contributor, while in reality its the same. how do we tell a triager to not pretend
they have additional privilege while reviewing a PR?
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.
triagers do not have permission to do those
I'm not sure I agree, anyone can submit a review, approve or request changes. Anyway, I think we do not agree on whether the difference in GH UI is enough to avoid confusion, and we'll have to agree to disagree.
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.
and we'll have to agree to disagree.
agree.
anyone can submit a review, approve or request changes.
is it an opinion, endorsed process, or a best practice? in any case pls show me a documented evidence of this being the case - as this to me is a deviation from github defined roles and permissions.
if anyone can request changes, what is your recommendation to authors of PRs when a non-collaborator does so? are they bound to address it?
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.
By "anyone can submit a review, approve or request changes.", I was meaning "it is a feature that GitHub offers", I didn't mean that anyone can block a PR from landing.
are they bound to address it?
IMO yes, ideally all comments should be addressed (which doesn't not mean they have to take the suggestion, e.g. adding a comment saying "Thanks for the suggestion, I prefer not to take it" would be a way to address it)
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.
given that we agreed to disagree on whether an author will be misled by a triager action on PRs and whether GH UI color code is sufficient to disambiguate that confusion or not, I will yield and go ahead with what we have consensus on.
thanks @aduh95 !
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.
(ofc, the other topic: whether anyone can use all PR review actions or not - has wider scope, and just for triagers, and doesn't need to be sorted out here)
doc/contributing/issues.md
Outdated
@@ -60,5 +60,12 @@ activities, such as applying labels and closing/reopening/assigning issues. | |||
For more information on the roles and permissions, see ["Permission levels for | |||
repositories owned by an organization"](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization). | |||
|
|||
triagers are requested to abstain from below actions: |
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.
triagers are requested to abstain from below actions: | |
Triagers should refrain from the following actions: |
doc/contributing/issues.md
Outdated
* approve or request changes to a pull request | ||
* edit wikis | ||
|
||
triagers are requested to apply caution while performing below actions: |
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.
triagers are requested to apply caution while performing below actions: | |
Triagers should apply caution when performing the following actions: |
doc/contributing/issues.md
Outdated
* edit wikis | ||
|
||
triagers are requested to apply caution while performing below actions: | ||
* close or assign issues or prs |
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.
* close or assign issues or prs | |
* Closing and/or assigning issues or PRs. |
* Show no patience towards spam or troll, close the issue without interacting with it and | ||
report the user to the moderation repository. | ||
* If you're not able to reproduce an issue, leave a comment asking for more info and | ||
add the `needs more info` label. |
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.
This label doesn't exist
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 should create it +1
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 can probably replace repro exists
as an inverse.
When triagging issues and PR: | ||
|
||
* Show patience and empathy, especially to first-time contributors. | ||
* Show no patience towards spam or troll, close the issue without interacting with it and |
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.
* Show no patience towards spam or troll, close the issue without interacting with it and | |
* Show no patience towards spam or trolls, close the issue/PR without interacting with it and |
doc/contributing/issues.md
Outdated
@@ -60,5 +60,21 @@ activities, such as applying labels and closing/reopening/assigning issues. | |||
For more information on the roles and permissions, see ["Permission levels for | |||
repositories owned by an organization"](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization). | |||
|
|||
triagers are requested to abstain from below actions: | |||
* approve or request changes to a pull request |
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.
* approve or request changes to a pull request | |
* Approving or requesting changes to a pull request. |
highlight additional points around triager role Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
e68e0fb
to
319353d
Compare
Landed in e542686 |
highlight additional points around triager role Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com> PR-URL: #55775 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
highlight additional points around triager role Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com> PR-URL: nodejs#55775 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
highlight additional points around triager role