doc: onboarding.md landing prs multiple commits #9635
Conversation
|
cc/ @sam-github |
doc/onboarding.md
Outdated
There was a problem hiding this comment.
Landed in is not required according to https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#landing-pull-requests.
These two documents should agree. Either by making them say the same thing, or by making onboarding be a reference to the collaborator guide.
There was a problem hiding this comment.
Its not clear what "automatically merged" means. github never automatically merges anything, unless you mean when the green button is pressed by a human. I think you mean "when github detects the branch was merged"? In which case, you probably have to discuss the subtleties of how it does that. And maybe mention that a Landed in is never the wrong thing?
cc: @Fishrock123
There was a problem hiding this comment.
@sam-github As in: if you push a commit to master that has the same hash as the HEAD of a PR branch, then Github will automatically mark the PR as merged. I guess the wording should be more exact.
There was a problem hiding this comment.
ok, so subtle is in the eye of the beholder when it comes to git :-), but I don't think "github automatically merged your commit" is the same as "the branches commits were fast-forwarded onto master so the master contains the exact SHA commit IDs as the PR branch did". Anyhow, point is, if there is a documented exception, the docs should go a bit more into it, perhaps recommending force pushing your own branches since you can, but pointing out that's not usually possible with branches you don't own.
There was a problem hiding this comment.
I'll look at rewriting this to make it clearer, perhaps to make more of a distinction between COLLABORATOR_GUIDE and onboarding.md (#9555 (comment)).
BethGriggs
force-pushed
the
pr-onboarding-multi-commits
branch
from
eee8811 to
346f675
Compare
COLLABORATOR_GUIDE.md
Outdated
There was a problem hiding this comment.
... " or approved the request using the github review mechanism."
There was a problem hiding this comment.
I guess de facto it's allowed, but I'm not sure discussion on using it ever reached any kind of consensus (ref: #8554).
COLLABORATOR_GUIDE.md
Outdated
There was a problem hiding this comment.
"When the pull request is closed" ---> "When the amended commit is fast-forward merged onto master, github will automatically close the PR, and mark it with the purple merge status"....
There was a problem hiding this comment.
You text made it sound like if you close a PR using the "close pull request" button that it would show as merged, but you mean "closing a PR in the way node does it"
COLLABORATOR_GUIDE.md
Outdated
There was a problem hiding this comment.
I think you mean the "default git pager, less" here, not vim? Usually git log, when output is longer than the terminal uses the git pager, which defaults to less, and less (as well as the old pager, more, vim, and lots of tools) uses / for searching.
There was a problem hiding this comment.
This was copied from https://github.com/nodejs/node/blob/master/doc/onboarding.md#landing-prs-details.
I agree it should be less.
COLLABORATOR_GUIDE.md
Outdated
There was a problem hiding this comment.
https://github.com/evanlucas/node-review can help a lot to do this list
There was a problem hiding this comment.
I agree that we should officially document this
COLLABORATOR_GUIDE.md
Outdated
BethGriggs
force-pushed
the
pr-onboarding-multi-commits
branch
13 times, most recently
from
e701f36 to
c1cbe63
Compare
doc/onboarding.md
Outdated
COLLABORATOR_GUIDE.md
Outdated
There was a problem hiding this comment.
Probably worth mentioning https://github.com/evanlucas/core-validate-commit and https://github.com/evanlucas/node-review here.
COLLABORATOR_GUIDE.md
Outdated
There was a problem hiding this comment.
I think this is an excessive number of brackets.
(-j8 builds node in parallel with 8 threads. Adjust to the number of processor cores/threads your machine has for best results.)
COLLABORATOR_GUIDE.md and onboarding.md cover some of the same information. The aim of this commit is to remove duplicated information.
BethGriggs
force-pushed
the
pr-onboarding-multi-commits
branch
from
c1cbe63 to
1845c1d
Compare
|
Updated, PTAL. I have not included the changes to document evanlucas/node-review as I feel this should be part of a separate PR. |
|
Landed in 8951d3e |
COLLABORATOR_GUIDE.md and onboarding.md cover some of the same information. The aim of this commit is to remove duplicated information. PR-URL: #9635 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sam Roberts <[email protected]>
COLLABORATOR_GUIDE.md and onboarding.md cover some of the same information. The aim of this commit is to remove duplicated information. PR-URL: #9635 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sam Roberts <[email protected]>
COLLABORATOR_GUIDE.md and onboarding.md cover some of the same information. The aim of this commit is to remove duplicated information. PR-URL: nodejs#9635 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sam Roberts <[email protected]>
COLLABORATOR_GUIDE.md and onboarding.md cover some of the same information. The aim of this commit is to remove duplicated information. PR-URL: #9635 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sam Roberts <[email protected]>
COLLABORATOR_GUIDE.md and onboarding.md cover some of the same information. The aim of this commit is to remove duplicated information. PR-URL: #9635 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sam Roberts <[email protected]>
8 participants
Checklist
Affected core subsystem(s)
doc
Description of change
onboarding.md and COLLABORATOR_GUIDE.md cover much of the same ground, this PR aims to remove some of the duplicated content to avoid ambiguity.