doc: improve onboarding instructions · nodejs/node@06cd746

@@ -230,11 +230,13 @@ needs to be pointed out separately during the onboarding.

230230

labels. The `fast-track` label should cause the Node.js GitHub bot to post a

231231

comment in the pull request asking collaborators to approve the pull request

232232

by leaving a 👍 reaction on the comment.

233-

* Optional: Run CI on the pull request. Use the `node-test-pull-request` CI

233+

* Optional: Run Jenkins CI on the pull request. Use the [`node-test-pull-request`][]

234234

task. As a convenience, you may apply the `request-ci` label to the pull

235235

request to have a GitHub Actions workflow start the Jenkins CI task for you.

236236

* After two Collaborator approvals for the change and two Collaborator approvals

237-

for fast-tracking, land the PR.

237+

for fast-tracking, land the PR. If you have started a full Jenkins CI, cancel it

238+

from the Jenkins UI since the PR is a doc-only change and does not need

239+

a full CI run, it is just run as an exercise.

238240

* If there are not enough approvals within a reasonable time, consider the

239241

single approval of the onboarding TSC member sufficient, and land the pull

240242

request.

@@ -245,6 +247,20 @@ needs to be pointed out separately during the onboarding.

245247

* [`core-validate-commit`][] automates the validation of commit messages.

246248

This will be run during `git node land --final` of the [`git-node`][]

247249

command.

250+

* Normally you can just use the `commit-queue` label to have the

251+

commit queued for landing by the Node.js GitHub bot. But as exercise it is

252+

also useful to learn how to land commits manually in case the bot or the CI

253+

is broken.

254+

* If you are landing the commit manually, to make it appear as "Merged" on GitHub,

255+

after you prepare the landed commit on the local `main` branch, run this:

256+257+

```bash

258+

git push --force-with-lease your-fork-remote HEAD:your-pr-branch # Update the PR branch in your fork.

259+

git push upstream main # Push the landed commit to the upstream main branch.

260+

```

261+262+

GitHub will automatically detect that the PR branch is now identical to the

263+

`main` branch and will mark the PR as "Merged".

248264249265

## Final notes

250266

@@ -253,11 +269,14 @@ needs to be pointed out separately during the onboarding.

253269

* Almost any mistake you could make can be fixed or reverted.

254270

* The existing collaborators trust you and are grateful for your help!

255271

* Other repositories:

256-

* <https://github.com/nodejs/TSC>

257-

* <https://github.com/nodejs/build>

258-

* <https://github.com/nodejs/nodejs.org>

259-

* <https://github.com/nodejs/Release>

260-

* <https://github.com/nodejs/citgm>

272+

* <https://github.com/nodejs/TSC>: Governance discussions and TSC votes

273+

* <https://github.com/nodejs/build>: Build infrastructure discussions and CI issues

274+

* <https://github.com/nodejs/nodejs.org>: The Node.js website and blog

275+

* <https://github.com/nodejs/Release>: Release management and release planning

276+

* <https://github.com/nodejs/citgm>: Tool for testing popular packages against Node.js changes

277+

* <https://github.com/nodejs/admin>: Administrative issues and requests to changes in the Node.js

278+

GitHub organization (e.g. creating new repositories, new teams, adding organization-wide tokens).

279+

* <https://github.com/nodejs/moderation>: Requests to moderate comments or block spammers.

261280

* The OpenJS Foundation hosts regular summits for active contributors to the

262281

Node.js project, where we have face-to-face discussions about our work on the

263282

project. The Foundation has travel funds to cover [participants' expenses][]

@@ -266,6 +285,8 @@ needs to be pointed out separately during the onboarding.

266285

repository for details.

267286

* If you are interested in helping to fix coverity reports consider requesting

268287

access to the projects coverity project as outlined in [static-analysis][].

288+

* If you are interested in helping out with CI reliability, check out the

289+

[reliability respository][] and [guide on how to deal with CI flakes][].

269290270291

[Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md

271292

[Labels]: doc/contributing/collaborator-guide.md#labels

@@ -275,7 +296,10 @@ needs to be pointed out separately during the onboarding.

275296

[`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests

276297

[`core-validate-commit`]: https://github.com/nodejs/core-validate-commit

277298

[`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md

299+

[`node-test-pull-request`]: https://ci.nodejs.org/job/node-test-pull-request/

300+

[guide on how to deal with CI flakes]: https://github.com/nodejs/test?tab=readme-ov-file#protocols-in-improving-ci-reliability

278301

[participants' expenses]: https://github.com/openjs-foundation/cross-project-council/blob/main/community-fund/COMMUNITY_FUND_POLICY.md#community-fund-rules

302+

[reliability respository]: https://github.com/nodejs/reliability

279303

[set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-github-credentials

280304

[static-analysis]: doc/contributing/static-analysis.md

281305

[two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/