Commit Graph

6 Commits (91f05448894e07831eb91118e5ab361a1c350116)

Author SHA1 Message Date
Rich Trott c38bb43ca4 doc: revise onboarding-extras
Revise onboarding-extras for style guide conformance and minor wording
improvements.

PR-URL: https://github.com/nodejs/node/pull/34496
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2020-07-25 19:17:48 -07:00
Rich Trott 0679076720 doc: remove breaking-change-helper from onboarding-extras
I don't think anyone uses the breaking change helper code that is in
onboarding-extras. I'm not sure it works for us anyway as I think it
will fail if there are any breaking changes since the last release. That
may be helpful to releasers, but that is not helpful in determining if
an individual commit is semver-major or not. Regardless, I don't think
it gets used and I'm interested in not weighing down the onboarding
process with a bunch of things that we don't actually use/do.

PR-URL: https://github.com/nodejs/node/pull/34497
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2020-07-25 13:02:00 -07:00
Ruy Adorno bfef588339
doc: add author-ready label ref to onboarding doc
The "Labels" section of doc/guides/onboarding-extras.md was missing a
reference to the `author-ready` label. This commit adds a description
similar to the definition found in doc/guides/collaborator-guide.md
with the goal of making it easier for new contributors to find labels
info all in one place.

PR-URL: https://github.com/nodejs/node/pull/34381
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
2020-07-22 11:23:45 -04:00
Derek Lewis 549812a9a0 doc: normalize Bash code block info strings
Prior to this commit, Bash fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standardize on
the less-obscure variant.

PR-URL: https://github.com/nodejs/node/pull/33510
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-05-25 19:08:45 +02:00
Rich Trott f67601cd77 doc: add `tsc-agenda` to onboarding labels list
PR-URL: https://github.com/nodejs/node/pull/32832
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-04-18 05:34:16 -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