Skip to content
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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/contributing/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Member

@RedYetiDev RedYetiDev Nov 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
triagers are requested to abstain from below actions:
Triagers should refrain from the following actions:

* approve or request changes to a pull request
Copy link
Member

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:

  1. Welcoming first-time contributors/issue posters
  2. Where this is unclear, leave the issue or pull request open for several days to allow for discussion.
  3. Most importantly, be friendly.

Copy link
Member Author

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)?

Copy link
Contributor

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?

Copy link
Member

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.

Copy link
Member Author

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gireeshpunathil no matter what I think, the text in the PR should clarify to whom it applies to. i.e. you're the one who should clarify, not me :D

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for me, this applies to triagers, who are wanting to exercise their triage role.

when they are also a collaborator or a tsc member, their respective role definitions augment into this one, and the highest role among all apply for a specific action. that is neither captured here, nor overridden here.

from your explanation, the action pertinent to the role was also not clear to me. review looks like an overloaded term. it comprises at least of:

  • submit reviews on PRs
  • approve or request changes on PRs

reference from GH docs (second column is for triagers)

Screenshot 2024-11-08 at 8 02 41 PM

I am not proposing triagers refrain from submitting reviews. instead, approving or requesting changes. triagers do not have permission to do those, but if they perform these, it may confuse authors. so make it explicit here.

Copy link
Contributor

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.

Copy link
Member Author

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?

Copy link
Contributor

@aduh95 aduh95 Nov 8, 2024

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)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* approve or request changes to a pull request
* Approving or requesting changes to a pull request.

* edit wikis

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* 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

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.
Copy link
Member

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

Copy link
Member

@marco-ippolito marco-ippolito Nov 8, 2024

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

Copy link
Member

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.

* Ideally issues should be closed only when they have been fixed or answered (and
merged for pull requests). Closing an issue (or PR) earlier can be seen as
dismissive from the point of view of the reporter/author.
Always try to communicate the reason for closing the issue/PR.

[Node.js help repository]: https://github.com/nodejs/help/issues
[Technical Steering Committee (TSC) repository]: https://github.com/nodejs/TSC/issues
Loading