Michael Dawson
a199387f04
doc: make contributing info more discoverable
...
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 >
2022-01-18 14:24:30 -05:00
Antoine du Hamel
f92af52105
doc: fix typo in onboarding.md
...
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 >
2022-01-15 23:03:44 +00:00
Michael Dawson
9ebdba49c7
doc: add info on project's usage of coverity
...
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 >
2021-10-25 16:43:40 -04:00
Rich Trott
566365dd9d
doc: update onboarding task
...
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 >
2021-10-24 19:01:07 +00:00
Rich Trott
3d3aa5d837
doc: fix entry for Slack channel in onboarding.md
...
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 >
2021-10-22 11:06:31 -07:00
Rich Trott
0d59d0d1c3
doc: update link in onboarding doc
...
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 >
2021-10-21 22:09:50 -07:00
Rich Trott
549f96889a
doc: update markdown formatting for *.md files
...
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 >
2021-09-21 15:37:19 +00:00
Rich Trott
c154c6c5cf
doc: remove outdated step in onboarding exercise
...
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 >
2021-07-19 07:27:19 -07:00
Rich Trott
def3260b03
doc: use _pull request_ instead of _PR_ in onboarding doc
...
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 >
2021-07-18 18:32:48 +00:00
Rich Trott
7dbc0f74d0
doc: standardize on _pull request_
...
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 >
2021-07-16 10:36:30 -07:00
Rich Trott
0d42470798
doc: standardize on not capitalizing _collaborator_
...
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 >
2021-07-15 17:21:39 -07:00
Rich Trott
f0838a09f1
doc: do not use & for "and" in text
...
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 >
2021-07-12 15:50:51 -07:00
Rich Trott
bbdc15bbdb
doc: use "repository" instead of "repo" in onboarding.md
...
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 >
2021-07-08 06:58:55 -07:00
Rich Trott
2fd687ae1f
doc: remove onboarding-extras
...
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 >
2021-07-05 14:01:20 -07:00
devsnek
e3ba96053e
doc: remove references to deleted freenode channels
...
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 >
2021-06-17 07:43:23 -05:00
Michael Dawson
7a4c2c8d86
doc: change links to use HEAD in top level docs
...
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 >
2021-02-27 12:03:22 -08:00
Joyee Cheung
35fe310b0a
doc: mention adding Fixes to collaborator onboarding PR
...
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 >
2021-01-27 19:55:30 +08:00
Antoine du Hamel
7794d36a37
tools,doc: enforce alphabetical order for md refs
...
PR-URL: https://github.com/nodejs/node/pull/35244
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Shelley Vohr <codebytere@gmail.com >
2020-09-22 10:25:43 -07:00
Mary Marchini
9d9d2f0cf7
meta: add links to OpenJSF Slack
...
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 >
2020-09-13 06:33:32 -07:00
Gireesh Punathil
983364c0ff
doc: onboarding process extras
...
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 >
2020-07-24 10:11:52 +05:30
Nick Schonning
7183d70273
doc: add angle brackets around implicit links
...
PR-URL: https://github.com/nodejs/node/pull/32676
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-04-23 21:48:17 -07:00
Juan José Arboleda
5c535386ac
doc: replace node-test-pull-request-lite-pipeline from onboarding
...
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 >
2020-04-11 10:23:56 -07:00
Alba Mendez
882b61a7ee
doc: fix more links
...
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 >
2020-04-02 23:36:34 +02:00
Antoine du HAMEL
19db0e60bd
doc: tests local links in markdown documents
...
PR-URL: https://github.com/nodejs/node/pull/32359
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-03-30 10:20:59 +02:00
Thomas Watson
509a184820
doc: fix some 404 links
...
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 >
2020-03-18 16:11:59 -07:00
ConorDavenport
bf7409e974
doc: improve doc/markdown file organization coherence
...
* 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 >
2020-03-04 13:13:07 +00:00