summaryrefslogtreecommitdiff
path: root/onboarding.md
Commit message (Collapse)AuthorAgeFilesLines
* meta: remove unnecessary onboarding stepRich Trott2023-02-251-2/+0
| | | | | | | | | | | | | | | | | | | While it is nice to notify the TSC about accepted nominations, it is not strictly necessary and I think we should streamline things as much as possible. PR-URL: https://github.com/nodejs/node/pull/46793 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
* doc: update name of Node.js core Slack channelRich Trott2022-11-031-1/+1
| | | | | | | | | | The name has been changed from nodejs-dev to nodejs-core. PR-URL: https://github.com/nodejs/node/pull/45293 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
* doc: clarify moderation in `onboarding.md`Benjamin Gruenbaum2022-10-281-2/+9
| | | | | | | | | | This change gives more attention to moderation requirements collaborators can perform as part of the onboarding process. PR-URL: https://github.com/nodejs/node/pull/41930 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Michael Dawson <midawson@redhat.com>
* doc: update repository list in onboarding docRich Trott2022-08-031-2/+1
| | | | | | | | | | | | | | | LTS repo is now Release. readable-stream is important but a bit of a specialized topic. The others listed here are of general interest. PR-URL: https://github.com/nodejs/node/pull/44089 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Feng Yu <F3n67u@outlook.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
* doc: clarify part of onboarding guide regarding adding to teamsDarshan Sen2022-07-311-2/+2
| | | | | | | | | | | | | | | | | | | There are a number of teams (for example, the build team) which require more than just showing interest as a prerequisite for being added, so this change adds a link to the set of subsystem teams where new Collaborators can be added directy. Also, the doc didn't actually mention if the new Collaborator should be added to the team. This change also clarifies that. Refs: https://github.com/nodejs/build/issues/3003 Signed-off-by: Darshan Sen <raisinten@gmail.com> PR-URL: https://github.com/nodejs/node/pull/44024 Reviewed-By: Feng Yu <F3n67u@outlook.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
* doc: update main branch name in onboarding.mdFeng Yu2022-06-161-1/+1
| | | | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/43443 Refs: https://github.com/nodejs/node/issues/33864 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: LiviaMedeiros <livia@cirno.name> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
* doc: use ASCII apostrophes consistentlyTobias Nießen2022-05-171-4/+4
| | | | | | | | PR-URL: https://github.com/nodejs/node/pull/43114 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
* doc: remove git:// protocol, adjust nits in onboarding.mdLiviaMedeiros2022-05-131-5/+5
| | | | | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/43045 Refs: https://github.blog/2021-09-01-improving-git-protocol-security-github/ Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
* doc: make contributing info more discoverableMichael Dawson2022-01-181-5/+5
| | | | | | | | | | | | | | | There are been several discussions in recent PRs about the docs related to contributing not being very discoverable. Move these docs from doc/guides/ to doc/contributing. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/41408 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: fix typo in `onboarding.md`Antoine du Hamel2022-01-151-1/+1
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/41544 Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: add info on project's usage of coverityMichael Dawson2021-10-251-0/+3
| | | | | | | | | | | Document project's used of coverity and how collaborators can get access. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/40506 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com>
* doc: update onboarding taskRich Trott2021-10-241-1/+3
| | | | | | | | | | Make starting Jenkins CI optional. PR-URL: https://github.com/nodejs/node/pull/40570 Reviewed-By: Voltrex <mohammadkeyvanzade94@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: fix entry for Slack channel in onboarding.mdRich Trott2021-10-221-2/+2
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/40563 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Voltrex <mohammadkeyvanzade94@gmail.com>
* doc: update link in onboarding docRich Trott2021-10-211-1/+1
| | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/40539 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
* doc: update markdown formatting for *.md filesRich Trott2021-09-211-10/+18
| | | | | | | | | | | Fix formatting that will change when run through upcoming remark preset. PR-URL: https://github.com/nodejs/node/pull/40154 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
* doc: remove outdated step in onboarding exerciseRich Trott2021-07-191-4/+4
| | | | | | | | | The GitHub bot will leave a comment asking people to thumbs-up a fast track request so there is no need to manually leave such a comment. PR-URL: https://github.com/nodejs/node/pull/39410 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: use _pull request_ instead of _PR_ in onboarding docRich Trott2021-07-181-17/+19
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/39409 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: standardize on _pull request_Rich Trott2021-07-161-2/+2
| | | | | | | | | | | | | | | | | | | | Sometimes we capitalize _pull request_ and sometimes we don't. Standardize on lowercase based on Microsoft Style Guide, Chicago Manual of Style, and GitHub's own docs and UI. Refs: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests Refs: https://docs.github.com/en/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request Refs: https://docs.microsoft.com/en-us/style-guide/capitalization PR-URL: https://github.com/nodejs/node/pull/39384 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
* doc: standardize on not capitalizing _collaborator_Rich Trott2021-07-151-6/+6
| | | | | | | | | | | | | | | | | | Sometimes we capitalize _collaborator_ and sometimes not. After consulting the Microsoft Style Guide and The Chicago Manual of Style, I've concluded it is best to not capitalize it. For consistency, apply that to our various .md files. Refs: https://docs.microsoft.com/en-us/style-guide/capitalization PR-URL: https://github.com/nodejs/node/pull/39379 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: do not use & for "and" in textRich Trott2021-07-121-2/+2
| | | | | | | | | | | | | This also changes a line in the man page to be sentence case. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/special-characters PR-URL: https://github.com/nodejs/node/pull/39345 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
* doc: use "repository" instead of "repo" in onboarding.mdRich Trott2021-07-081-4/+4
| | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/39286 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: remove onboarding-extrasRich Trott2021-07-051-1/+2
| | | | | | | | | | | Migrate last bit of onboarding-extras content to collaborator-guide and remove onboarding-extras. PR-URL: https://github.com/nodejs/node/pull/39252 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: remove references to deleted freenode channelsdevsnek2021-06-171-9/+0
| | | | | | | | | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/39047 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
* doc: change links to use HEAD in top level docsMichael Dawson2021-02-271-3/+3
| | | | | | | | | | | | Change the top level docs to use HEAD in links Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/37494 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
* doc: mention adding Fixes to collaborator onboarding PRJoyee Cheung2021-01-271-3/+6
| | | | | | | | | | Also update the example to include the Fixes url. PR-URL: https://github.com/nodejs/node/pull/37097 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com>
* tools,doc: enforce alphabetical order for md refsAntoine du Hamel2020-09-221-2/+2
| | | | | | PR-URL: https://github.com/nodejs/node/pull/35244 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com>
* meta: add links to OpenJSF SlackMary Marchini2020-09-131-5/+9
| | | | | | | | | | | | | | The OpenJS Foundation has an official Slack, and the Node.js project has many channels there for working groups as well as for general discussions. Add links to the workspace and channels for folks who want to join. PR-URL: https://github.com/nodejs/node/pull/35128 Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
* doc: onboarding process extrasGireesh Punathil2020-07-241-0/+3
| | | | | | | | | | Callout some practices explicitly, so that the process is followed in a similar manner PR-URL: https://github.com/nodejs/node/pull/34455 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
* doc: add angle brackets around implicit linksNick Schonning2020-04-231-2/+2
| | | | | PR-URL: https://github.com/nodejs/node/pull/32676 Reviewed-By: Rich Trott <rtrott@gmail.com>
* doc: replace node-test-pull-request-lite-pipeline from onboardingJuan José Arboleda2020-04-111-2/+1
| | | | | | | | | | | Replace the obsolete node-test-pull-request-lite-pipeline CI task in favour of node-test-pull-request. PR-URL: https://github.com/nodejs/node/pull/32736 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Zeyu Yang <himself65@outlook.com>
* doc: fix more linksAlba Mendez2020-04-021-1/+1
| | | | | | | | | | | | | | | | Fix broken links found by the checker, and exclude test/fixtures as it contains invalid links. Also exclude doc/changelogs because they're huge files which take very long to parse, and (IIRC) are auto-generated anyway. (Oh and also a nit at the README next to my link) PR-URL: https://github.com/nodejs/node/pull/32586 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: tests local links in markdown documentsAntoine du HAMEL2020-03-301-1/+1
| | | | | | PR-URL: https://github.com/nodejs/node/pull/32359 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com>
* doc: fix some 404 linksThomas Watson2020-03-181-3/+3
| | | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/32200 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: improve doc/markdown file organization coherenceConorDavenport2020-03-041-0/+251
* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: https://github.com/nodejs/node/issues/31741 PR-URL: https://github.com/nodejs/node/pull/31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
View Lorry Controller Status