-
Notifications
You must be signed in to change notification settings - Fork 30k
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
docs,meta: assign PR semantics #23292
Conversation
COLLABORATOR_GUIDE.md
Outdated
Check PRs from new contributors to make sure the person's name and email address | ||
are correct before merging. | ||
For PRs from first time contributors it is recommended to be | ||
[welcoming][#welcoming-first-time-contributors] and verify that the git settings |
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.
[#welcoming-first-time-contributors]
-> (#welcoming-first-time-contributors)
(otherwise, the link is not rendered).
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.
ack
Doc format and wording LGTM with a nit. |
COLLABORATOR_GUIDE.md
Outdated
one](https://github.com/nodejs/node/commit/b636ba8186) if unsure exactly how | ||
to format your commit messages. | ||
1. Add all necessary [metadata](#metadata) to commit messages before landing. If | ||
You are unsure exactly how to format the commit messages, use the commit log |
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.
s/You/you/
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.
ack
COLLABORATOR_GUIDE.md
Outdated
to format your commit messages. | ||
1. Add all necessary [metadata](#metadata) to commit messages before landing. If | ||
You are unsure exactly how to format the commit messages, use the commit log | ||
as a reference, for examples commits such as [this one][commit-example]. |
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 sentence should end here at 'reference' and the last part re-worded. Perhaps something like 'See [this commit][commit-example] as an example.'
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.
ack
|
4784d75
to
3a68aaf
Compare
COLLABORATOR_GUIDE.md
Outdated
@@ -99,7 +99,8 @@ As soon as the PR is ready to land, please do so. Landing your own pull requests | |||
allows other Collaborators to focus on other pull requests. If your pull request | |||
is still awaiting the [minimum time to land](#waiting-for-approvals), add the | |||
`author ready` label so other Collaborators know it can land as soon as the time | |||
ends. | |||
ends. If instead you wish to land the PR yourself, indicate this intent by using | |||
the "assign yourself" button, to self assign the 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.
typo: self-assign
COLLABORATOR_GUIDE.md
Outdated
@@ -504,12 +505,15 @@ The TSC should serve as the final arbiter where required. | |||
|
|||
## Landing Pull Requests | |||
|
|||
1. Avoid landing PRs that are assigned to someone else. Authors who wish to land | |||
their own PRs will self assign them, or delegate to someone else. |
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.
“If in doubt, ask the assignee whether it is okay to land?”
6c2c16f
to
c254e71
Compare
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.
LGTM. A handful of nits/suggestions. Use as you see fit.
COLLABORATOR_GUIDE.md
Outdated
@@ -99,7 +99,8 @@ As soon as the PR is ready to land, please do so. Landing your own pull requests | |||
allows other Collaborators to focus on other pull requests. If your pull request | |||
is still awaiting the [minimum time to land](#waiting-for-approvals), add the | |||
`author ready` label so other Collaborators know it can land as soon as the time | |||
ends. | |||
ends. If instead you wish to land the PR yourself, indicate this intent by using | |||
the "assign yourself" button, to self-assign the 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.
Maybe just this?:
If you wish to land the PR yourself, use the "assign yourself" button to self-assign the PR.
COLLABORATOR_GUIDE.md
Outdated
@@ -504,12 +505,16 @@ The TSC should serve as the final arbiter where required. | |||
|
|||
## Landing Pull Requests | |||
|
|||
1. Avoid landing PRs that are assigned to someone else. Authors who wish to land | |||
their own PRs will self-assign them, or delegate to someone else. If in | |||
doubt, ask the assignee whether it is okay to land? |
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.
land?
-> land.
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.
Ack
COLLABORATOR_GUIDE.md
Outdated
* The "Create a merge commit" method will add an unnecessary merge commit. | ||
* The "Squash and merge" method will add metadata (the PR #) to the commit | ||
title, and if more than one author has contributed to the PR, squashing | ||
will only keep the most recent author when squashing. |
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.
Maybe this?:
The "Squash and merge" method will add metadata (the PR #) to the commit title. If more than one author has contributed to the PR, squashing will only keep the most recent author.
If you don't like that and prefer the existing wording, then my comment is to please remove when squashing
in squashing will only keep the most recent author when squashing.
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.
Ack
COLLABORATOR_GUIDE.md
Outdated
are correct before merging. | ||
For PRs from first time contributors it is recommended to be | ||
[welcoming](#welcoming-first-time-contributors) and verify that the git settings | ||
are to their liking. |
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.
How about this?:
For PRs from first time contributors, be [welcoming](#welcoming-first-time-contributors).
Also, verify that their git settings are to their liking.
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.
Ack
c254e71
to
33f7e58
Compare
PR-URL: nodejs#23292 Refs: nodejs#23249 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: nodejs#23292 Refs: nodejs#23249 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
33f7e58
to
fc0da7f
Compare
/CC the non-existing @nodejs/colab-governance (for in lieu of pinging all Collaborators) :shrung:
Refs: #23249
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes