doc: adding labels doesn't require commit rights #92941
Conversation
As of [RFC 39][1], package maintainers are members of the NixOS github organization who don't have commit rights. However, they *do* have what GitHub calls [Triage rights][2], which means that package maintainers are able to add labels to PRs. The documentation should make this clear. I don't know the right way to phrase this in the docs, but the current text of "Requires commit rights" is definitely incorrect. [1]: https://discourse.nixos.org/t/join-the-package-maintainer-team/3751 [2]: https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#repository-access-for-each-permission-level
| @@ -49,7 +49,7 @@ | |||
| <itemizedlist> | |||
| <listitem> | |||
| <para> | |||
| Add labels to the pull request. (Requires commit rights) | |||
| Add labels to the pull request. (Requires maintainer rights) | |||
There was a problem hiding this comment.
s/maintainer/triage/
The maintainer privilege set is different from the triage privilege set on GitHub (see: https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#repository-access-for-each-permission-level).
There was a problem hiding this comment.
That might be the case, but I think the language of github permissions is too low-level for this doc. Users shouldn’t need to understand the low level github permissions system, and how that maps on to teams in the NixOS org. The important question is, “what governs whether a user can add labels to PRs in the NixOS org?”, in language the user understands and can take action on.
I think it might be as simple as “all package maintainers” or “all NixOS org members” (“but who gets to be an org member?” is the natural question arising here)
There was a problem hiding this comment.
Why not both? That way, we can keep a high level user facing explanation ("NixOS org terminology"), and make it clear to people who know about GitHub rights exactly what's going on. 😃
There was a problem hiding this comment.
The nixpkgs manual is already way too long and unfocused. I don’t want to add to that.
We should maybe document the GitHub permissions thing somewhere, but this isn’t the doc section to do it.
ofborg
bot
added
8.has: documentation
|
Thought: now that OfBorg automatically adds labels, do we even need documentation encouraging reviewers to do it? Could we just get rid of those lines? |
|
I marked this as stale due to inactivity. → More info |
stale
bot
added
the
2.status: stale
SuperSandro2000
added
the
2.status: merge conflict
stale
bot
removed
the
2.status: stale
|
I marked this as stale due to inactivity. → More info |
stale
bot
added
the
2.status: stale
asymmetric
added
the
6.topic: documentation
stale
bot
removed
the
2.status: stale
wegank
added
the
2.status: stale
Motivation for this change
As of RFC 39, package maintainers are members of the NixOS github
organization who don't have commit rights. However, they do have what
GitHub calls Triage rights, which means that package maintainers
are able to add labels to PRs. The documentation should make this
clear.
I don't know the right way to phrase this in the docs, but the current
text of "Requires commit rights" is definitely incorrect.
Things done
sandboxinnix.confon non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)nix path-info -Sbefore and after)