Skip to content

Commit fbdc16a

Browse files
TrottMyles Borins
authored and
Myles Borins
committed
doc: update labels and CI info in onboarding doc
PR-URL: #7006 Reviewed-By: Robert Jefe Lindstaedt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
1 parent cde3014 commit fbdc16a

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

doc/onboarding.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,13 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
5454
* Still need to follow the Code of Conduct.
5555

5656

57-
* labels:
58-
* generally sort issues by a concept of "subsystem" so that we know what part(s) of the codebase it touches, though there are also other useful labels.
59-
* [**See "Labels"**](./onboarding-extras.md#labels)
60-
* `ctc-agenda` if a topic is controversial or isn't coming to a conclusion after an extended time.
57+
* Labels:
58+
* There is [a bot](https://github.com/nodejs-github-bot/github-bot) that applies subsystem labels (for example, `doc`, `test`, `assert`, or `buffer`) so that we know what parts of the code base the pull request modifies. It is not perfect, of course. Feel free to apply relevant labels and remove irrelevant labels from pull requests and issues.
59+
* [**See "Labels"**](./onboarding-extras.md#labels)
60+
* Use the `ctc-agenda` if a topic is controversial or isn't coming to a conclusion after an extended time.
6161
* `semver-{minor,major}`:
62-
* be conservative – that is, if a change has the remote *chance* of breaking something, go for `semver-major`
63-
* when adding a semver label, add a comment explaining why you're adding it
64-
* it's cached locally in your brain at that moment!
65-
62+
* If a change has the remote *chance* of breaking something, use `semver-major`
63+
* When adding a semver label, add a comment explaining why you're adding it. Do it right away so you don't forget!
6664

6765
* Notifying humans
6866
* [**See "Who to CC in issues"**](./onboarding-extras.md#who-to-cc-in-issues)
@@ -103,14 +101,17 @@ Ensure everyone is added to https://github.com/orgs/nodejs/teams/collaborators
103101
* also, things that cannot be done outside of core, or only with significant pain (example: async-wrap)
104102

105103

106-
* CI testing:
107-
* lives here: https://ci.nodejs.org/
108-
* not automatically run - some of the platforms we test do not have full sandboxing support so we need to ensure what we run on it isn't potentially malicious
109-
* make sure to log in – we use github authentication so it should be seamless
110-
* go to "node-test-pull-request" and "Build with parameters"
111-
* fill in the pull request number without the `#`, and check the verification that you have reviewed the code for potential malice
112-
* The other options shouldn't need to be adjusted in most cases.
113-
* link to the CI run in the PR by commenting "CI: <ci run link>"
104+
* Continuous Integration (CI) Testing:
105+
* https://ci.nodejs.org/
106+
* It is not automatically run. You need to start it manually.
107+
* Log in on CI is integrated with GitHub. Try to log in now!
108+
* You will be using `node-test-pull-request` most of the time. Go there now!
109+
* To get to the form to start a job, click on `Build with Parameters`. (If you don't see it, that probably means you are not logged in!) Click it now!
110+
* To start CI testing from this screen, you need to fill in two elements on the form:
111+
* The `CERTIFY_SAFE` box should be checked. By checking it, you are indicating that you have reviewed the code you are about to test and you are confident that it does not contain any malicious code. (We don't want people hijacking our CI hosts to attack other hosts on the internet, for example!)
112+
* The `PR_ID` box should be filled in with the number identifying the pull request containing the code you wish to test. For example, if the URL for the pull request is https://github.com/nodejs/node/issues/7006, then put `7006` in the `PR_ID`.
113+
* The remaining elements on the form are typically unchanged.
114+
* There is a checkbox for `POST_STATUS_TO_PR`. At the time of this writing, that checkbox does not do anything, but that is likely to change soon. Until that functionality is working, you will want to go back to the PR you are testing and paste `CI: <URL-of-the-CI-test-run>` into a comment on the pull request.
114115

115116

116117
### process for getting code in:

0 commit comments

Comments
 (0)