doc: add guide and answers to FAQs for first-time contributors#63685
Open
joyeecheung wants to merge 5 commits into
Open
doc: add guide and answers to FAQs for first-time contributors#63685joyeecheung wants to merge 5 commits into
joyeecheung wants to merge 5 commits into
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
joyeecheung
force-pushed
the
first-time
branch
2 times, most recently
from
bfc12f2 to
5a9bf7c
Compare
trivikr
approved these changes
May 31, 2026
aduh95
reviewed
May 31, 2026
aduh95
reviewed
May 31, 2026
joyeecheung
commented
May 31, 2026
Member
|
Seemingly one of the more common tropes at the moment is opening PRs against issues with an existing open PR. I couldn't see any specific mention of this in our existing guidance, but this seems like a good place to discourage it. |
MoLow
approved these changes
Jun 1, 2026
Contributor
|
As a new contributor I was confused by not being able to access Jenkins logs and I thought I must be missing some privileges. As I later found out, that was due to being locked out because a security release was being prepared. Perhaps that should be mentioned somewhere? Maybe not just in the FAQs for first-time contributors, but also in the regular PR submission guidelines? |
MikeMcC399
reviewed
Jun 1, 2026
MikeMcC399
reviewed
Jun 1, 2026
Signed-off-by: Joyee Cheung <joyeec9h3@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Member
Author
|
@aduh95 @LiviaMedeiros @MikeMcC399 @trivikr @MoLow I think I addressed all the comments. Can you take a look again? Thanks! |
MikeMcC399
reviewed
Jun 28, 2026
|
|
||
| Commit squashing is usually handled by the automation. Commits that are intended to be squashed away don't | ||
| have to follow the commit message guidelines - only the ones whose commit message will be kept after | ||
| squashing do. If your stack of commits are already approved and the CI has passed on them, don't worry |
Contributor
There was a problem hiding this comment.
Suggested change
| squashing do. If your stack of commits are already approved and the CI has passed on them, don't worry | |
| squashing do. If your commits are already approved and the CI has passed on them, don't worry |
otherwise it would need to be "stack of commit is ..." to be grammatically correct, but that sounds a bit strange
MikeMcC399
reviewed
Jun 28, 2026
| label). The [commit queue automation](../../.github/workflows/commit-queue.yml) | ||
| will verify that the pull request meets all the requirements before merging it, but the | ||
| triggering of the commit queue still requires human judgement and depends on volunteers. | ||
| You can ask for help either in the pull request or in the slack channel similar |
Contributor
There was a problem hiding this comment.
Suggested change
| You can ask for help either in the pull request or in the slack channel similar | |
| You can ask for help either in the pull request or in the Slack channel similar |
branding
MikeMcC399
reviewed
Jun 28, 2026
| If the change is labeled `dont-land-*`, it will be held back from releases in the specified branch until | ||
| the label is removed. | ||
|
|
||
| If the change is labeled `semver-major`, it will only not be included in the next "Current" release. |
Contributor
There was a problem hiding this comment.
Suggested change
| If the change is labeled `semver-major`, it will only not be included in the next "Current" release. | |
| If the change is labeled `semver-major`, it will not be included in the next "Current" release. |
MikeMcC399
approved these changes
Jun 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This guide tries to capture some recurring issues I see (with suggestions that other collaborators seem to agree with in offline discussions) and address FAQs I constantly get when mentoring different new contributors.