Skip to content

doc: improve onboarding instructions #59159

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jul 24, 2025
Merged

doc: improve onboarding instructions #59159

merged 3 commits into from
Jul 24, 2025
+31 −7

Conversation

joyeecheung
Copy link
Member

@joyeecheung joyeecheung commented Jul 22, 2025 •
edited
Loading

  • Explains Jenkins CI
  • Document how to make the PR appear as "merged" if landed manually
  • Explain what other repositories are for.
  • Mention reliability repo and CI flakes

@joyeecheung
doc: improve onboarding instructions
5824780 
- Explains Jenkins CI
- Document how to make the PR appear as "merged" if landed manually
- Explain what other repositories are for.
- Mention reliability repo and CI flakes
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 22, 2025
aduh95
aduh95 reviewed Jul 22, 2025
View reviewed changes
onboarding.md Outdated
Comment on lines 254 to 265
* If you are landing the commit manually, to make it appear as "Merged" on GitHub,
after you prepare the landed commit on the local `main` branch, run this:

```bash
git checkout your-pr-branch
git reset --hard main # Synchronize your PR branch with the local main branch you just prepared.
git push --force-with-lease your-fork-remote your-pr-branch # Update the PR branch in your fork.
git checkout main
git push upstream main # Push the landed commit to the upstream main branch.
```
GitHub will automatically detect that the PR branch is now identical to the
`main` branch and will mark the PR as "Merged".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to mention ./tools/actions/merge.sh?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, shouldn't that be implemented in NCU so that there's no need to install gh separately?

RaisinTen
RaisinTen approved these changes Jul 22, 2025
View reviewed changes
Copy link
Member

@RaisinTen RaisinTen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

aduh95
aduh95 approved these changes Jul 22, 2025
View reviewed changes
@jasnell
Copy link
Member

jasnell commented Jul 22, 2025

@joyeecheung ... just a heads up, given the approvals I'm going to mark this author ready and add the commit-queue label.

@jasnell jasnell added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Jul 22, 2025
@joyeecheung
Copy link
Member Author

It seems the commit queue is getting stuck for some reason. Re-applying the labels..

@joyeecheung joyeecheung added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Jul 24, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jul 24, 2025
@nodejs-github-bot nodejs-github-bot merged commit 0938211 into nodejs:main Jul 24, 2025
34 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 0938211

@aduh95
Copy link
Contributor

aduh95 commented Jul 24, 2025

It seems the commit queue is getting stuck for some reason. Re-applying the labels..

Reapplying the label doesn't help, we do not use the labelled events. I don't think it was stuck, it was simply skipping the PR until it was open for 48 hours.

aduh95 pushed a commit that referenced this pull request Jul 25, 2025
@joyeecheung @aduh95
doc: improve onboarding instructions
06cd746 
- Explains Jenkins CI
- Document how to make the PR appear as "merged" if landed manually
- Explain what other repositories are for.
- Mention reliability repo and CI flakes

PR-URL: #59159
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Rafael Gonzaga <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
@github-actions github-actions bot mentioned this pull request Jul 28, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@UlisesGascon UlisesGascon UlisesGascon approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

@MoLow MoLow MoLow approved these changes

@aduh95 aduh95 aduh95 approved these changes

@RafaelGSS RafaelGSS RafaelGSS approved these changes

@RaisinTen RaisinTen RaisinTen approved these changes

@atlowChemi atlowChemi atlowChemi approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.