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: simplify author ready #24893

Closed
wants to merge 1 commit into from

Conversation

BridgeAR
Copy link
Member

@BridgeAR BridgeAR commented Dec 7, 2018

The label should be applied early on. Otherwise there is little
benefit using this label at all.

The change to require two LGs does not imply that this is also required
for the author ready label.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Dec 7, 2018
The label should be applied early on. Otherwise there is little
benefit using this label at all.
@BridgeAR BridgeAR force-pushed the simplify-author-ready branch from 85677b4 to 7036e25 Compare December 7, 2018 14:09
@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 7, 2018
@vsemozhetbyt
Copy link
Contributor

Should we cc @nodejs/collaborators to PSA the change?

@joyeecheung
Copy link
Member

joyeecheung commented Dec 8, 2018

Question: I have never really understood why the label is called author ready. I can understand what it means after reading the docs, but only after reading the docs...what's the meaning behind author in this context?

(This question does not have much thing to do with this PR itself, it's just a question)

@joyeecheung
Copy link
Member

Personally this is how my brain interprets the label: imagine there is a queue where there are a bunch of "something" that work through it, check if the PRs in the queue have a green CI and pass the various checks enforced by git-node-land & core-validate-commit, and land it when the PR pass the checks. The label essentially puts the PR in that queue.

(At the moment "something" = nice collaborators who have some time to do the work of landing things, the ideal would be "something" = a bot but that would be a bit far away)

@addaleax
Copy link
Member

addaleax commented Dec 8, 2018

@joyeecheung The author bit was added after the label was created, since it confused some people; it is supposed to say that there are no more tasks left for the author of the PR (unless maybe they are also a collaborator).

@Trott
Copy link
Member

Trott commented Dec 10, 2018

Landed in 4aabd7e

@Trott Trott closed this Dec 10, 2018
Trott pushed a commit to Trott/io.js that referenced this pull request Dec 10, 2018
The label should be applied early on. Otherwise there is little
benefit using this label at all.

PR-URL: nodejs#24893
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
@joyeecheung
Copy link
Member

joyeecheung commented Dec 13, 2018

The author bit was added after the label was created, since it confused some people; it is supposed to say that there are no more tasks left for the author of the PR (unless maybe they are also a collaborator).

The current description of the label does not seem to map to this accurately. If during the 7 day wait, another collaborator comes in and requests changes, then there are still tasks left for the author of the PR - to resolve the requested changes, in one way or another. And if the PR is semver-major, at least two TSC approvals are needed, in the worst case, a vote may be called and the decision may be against the current approach in the PR so the author may still need to update it if they still plan to pursue it, or they may have to close it.

@BridgeAR
Copy link
Member Author

@joyeecheung if another author requests further changes, the label should be removed again. Attaching it once does not mean it stays there :)

@joyeecheung
Copy link
Member

joyeecheung commented Dec 13, 2018

@BridgeAR Then what's the benefit of this label? For people landing PRs, they still need to look at the dates and count the reviews before go ahead and try landing the PR after seeing this label. For PR authors, they are still likely to wait and follow up with reviews after seeing this label. I think the label would be more useful if it's only applied when the criteria for reviews are satisfied and the only thing matters is to have someone coming in, making sure the CI is happy, checking the dates, and landing it - there is still a slight chance that someone may request changes before the PR gets landed by that would be less likely.

@joyeecheung
Copy link
Member

joyeecheung commented Dec 13, 2018

In my understanding, the ideal state for a PR to land, in terms of code reviews, is:

  1. It does not receive change requests in a sufficient amount of time, which signals that there is no obvious bugs in the code, or obvious mistakes in terms of decision making
  2. It has as many as possible reviews from collaborators with sufficient expertise in the code being touched

Having only one approval is fine when we simply cannot get more people to approve it and there is no point stalling it since no one raises objection either, but that's not ideal, and does not imply that the PR itself is necessarily ready in terms of code quality. To me, having a label with the word ready applied when only one approval is available signals that either:

  1. Only one approval is enough and the other approvals are simply formality, but that's not a good thing - we should not have such formality in the first place.
  2. Or, we are not actually respecting the standard that we are pursuing, then we should either change the standard or change the label.

BethGriggs pushed a commit that referenced this pull request Dec 17, 2018
The label should be applied early on. Otherwise there is little
benefit using this label at all.

PR-URL: #24893
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Dec 18, 2018
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
The label should be applied early on. Otherwise there is little
benefit using this label at all.

PR-URL: nodejs#24893
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
BethGriggs pushed a commit that referenced this pull request Feb 12, 2019
The label should be applied early on. Otherwise there is little
benefit using this label at all.

PR-URL: #24893
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Feb 12, 2019
BethGriggs pushed a commit that referenced this pull request Feb 20, 2019
The label should be applied early on. Otherwise there is little
benefit using this label at all.

PR-URL: #24893
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
rvagg pushed a commit that referenced this pull request Feb 28, 2019
The label should be applied early on. Otherwise there is little
benefit using this label at all.

PR-URL: #24893
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
@BridgeAR BridgeAR deleted the simplify-author-ready branch January 20, 2020 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.