Skip to content

Commit a40c28b

Browse files
TrottMylesBorins
authored andcommitted
doc: fix minor grammar/typographical issues in onboarding.md
PR-URL: #18847 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Minwoo Jung <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Matheus Marchini <[email protected]>
1 parent 3cc0b7c commit a40c28b

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

doc/onboarding.md

+20-21
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ onboarding session.
3636
* git:
3737
* Make sure you have whitespace=fix: `git config --global --add
3838
apply.whitespace fix`
39-
* Always continue to PR from your own github fork
40-
* Branches in the nodejs/node repository are only for release lines
41-
* [See "Updating Node.js from Upstream"][]
39+
* Always continue to PR from your own GitHub fork
40+
* Branches in the `nodejs/node` repository are only for release lines
41+
* See [Updating Node.js from Upstream][]
4242
* Make a new branch for each PR you submit.
4343
* Membership: Consider making your membership in the Node.js GitHub
4444
organization public. This makes it easier to identify Collaborators.
@@ -68,8 +68,8 @@ onboarding session.
6868
* The best outcome is for people who come to our issue tracker to feel like
6969
they can come back again.
7070

71-
* We have a [Code of Conduct][] that you are expected to follow *and* hold
72-
others accountable to
71+
* You are expected to follow *and* hold others accountable to the
72+
[Code of Conduct][].
7373

7474
## Managing the issue tracker
7575

@@ -89,8 +89,8 @@ onboarding session.
8989
* `semver-{minor,major}`:
9090
* If a change has the remote *chance* of breaking something, use the
9191
`semver-major` label
92-
* When adding a semver label, add a comment explaining why you're adding it.
93-
Do it right away so you don't forget!
92+
* When adding a `semver-*` label, add a comment explaining why you're adding
93+
it. Do it right away so you don't forget!
9494

9595
* [**See "Who to CC in issues"**](./onboarding-extras.md#who-to-cc-in-issues)
9696
* This will come more naturally over time
@@ -114,10 +114,9 @@ onboarding session.
114114
* Secondary (but not far off) is for the person submitting code to succeed. A
115115
pull request from a new contributor is an opportunity to grow the community.
116116
* Review a bit at a time. Do not overwhelm new contributors.
117-
* It is tempting to micro-optimize and make everything about relative
118-
performance. Don't succumb to that temptation. We change V8 often.
119-
Techniques that provide improved performance today may be unnecessary in
120-
the future.
117+
* It is tempting to micro-optimize. Don't succumb to that temptation. We
118+
change V8 often. Techniques that provide improved performance today may be
119+
unnecessary in the future.
121120
* Be aware: Your opinion carries a lot of weight!
122121
* Nits (requests for small changes that are not essential) are fine, but try to
123122
avoid stalling the pull request.
@@ -128,7 +127,7 @@ onboarding session.
128127
by tools but are not, consider implementing the necessary tooling.
129128
* Minimum wait for comments time
130129
* There is a minimum waiting time which we try to respect for non-trivial
131-
changes, so that people who may have important input in such a distributed
130+
changes so that people who may have important input in such a distributed
132131
project are able to respond.
133132
* For non-trivial changes, leave the pull request open for at least 48 hours
134133
(72 hours on a weekend).
@@ -151,12 +150,12 @@ onboarding session.
151150

152151
* What belongs in Node.js:
153152
* Opinions vary – it’s good to have a broad collaborator base for that reason!
154-
* If Node.js itself needs it (due to historic reasons), then it belongs in
155-
Node.js
156-
* That is to say, url is there because of http, freelist is there because of
157-
http, etc.
153+
* If Node.js itself needs it (due to historical reasons), then it belongs in
154+
Node.js.
155+
* That is to say, `url` is there because of `http`, `freelist` is there
156+
because of `http`, etc.
158157
* Things that cannot be done outside of core, or only with significant pain
159-
(for example `async_hooks`)
158+
such as `async_hooks`.
160159

161160
* Continuous Integration (CI) Testing:
162161
* [https://ci.nodejs.org/](https://ci.nodejs.org/)
@@ -226,9 +225,9 @@ onboarding session.
226225
* [https://github.com/nodejs/LTS](https://github.com/nodejs/LTS)
227226
* [https://github.com/nodejs/citgm](https://github.com/nodejs/citgm)
228227
* The Node.js Foundation hosts regular summits for active contributors to the
229-
Node.js project, where we have face-to-face discussion about our work on the
230-
project. The foundation has travel funds to cover participants' expenses
231-
including accommodation, transportation, visa fees etc. if needed. Check out
228+
Node.js project, where we have face-to-face discussions about our work on the
229+
project. The Foundation has travel funds to cover participants' expenses
230+
including accommodations, transportation, visa fees, etc. if needed. Check out
232231
the [summit](https://github.com/nodejs/summit) repository for details.
233232

234233
[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md
@@ -238,4 +237,4 @@ onboarding session.
238237
[Landing Pull Requests]: https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#landing-pull-requests
239238
[https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0]: https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0
240239
[Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/
241-
[See "Updating Node.js from Upstream"]: ./onboarding-extras.md#updating-nodejs-from-upstream
240+
[Updating Node.js from Upstream]: ./onboarding-extras.md#updating-nodejs-from-upstream

0 commit comments

Comments
 (0)