From ab3535d6aaff310c107834574812a41406c2d674 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 6 Dec 2017 06:11:29 -0800 Subject: [PATCH 1/2] doc: use correct and consistent typography for products Use `GitHub` rather than `Github` and `Node.js` rather than `Node.JS`. --- COLLABORATOR_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 95d5dccb59afef..99b94901fc9e8f 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -89,7 +89,7 @@ change. In the case of pull requests proposed by an existing Collaborator, an additional Collaborator is required for sign-off. In some cases, it may be necessary to summon a qualified Collaborator -or a Github team to a pull request for review by @-mention. +or a GitHub team to a pull request for review by @-mention. [See "Who to CC in issues"](./doc/onboarding-extras.md#who-to-cc-in-issues) If you are unsure about the modification and are not prepared to take @@ -156,7 +156,7 @@ or documentation. * [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/) uses [`CitGM`](https://github.com/nodejs/citgm) to allow you to run `npm install && npm test` on a large selection of common modules. This is useful to check whether a -change will cause breakage in the ecosystem. To test Node.JS ABI changes +change will cause breakage in the ecosystem. To test Node.js ABI changes you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/). * [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/) @@ -403,7 +403,7 @@ Changes" section of the release notes. Collaborators may opt to elevate pull requests or issues to the [TSC][] for discussion by assigning the `tsc-review` label or @-mentioning the -`@nodejs/tsc` Github team. This should be done where a pull request: +`@nodejs/tsc` GitHub team. This should be done where a pull request: - is labeled `semver-major`, or - has a significant impact on the codebase, or From 68da4b0c24726edaee1bf24823ad03e627918d97 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 6 Dec 2017 06:14:53 -0800 Subject: [PATCH 2/2] tools: lint for additional strings in docs Check for uses of `Github` (rather than `GitHub`) and `Node.JS` (rather than `Node.js`) in markdown files. --- tools/remark-preset-lint-node/index.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/tools/remark-preset-lint-node/index.js b/tools/remark-preset-lint-node/index.js index c5aef12d539542..a59d5d78d8fff8 100644 --- a/tools/remark-preset-lint-node/index.js +++ b/tools/remark-preset-lint-node/index.js @@ -42,8 +42,10 @@ module.exports.plugins = [ [ require('remark-lint-prohibited-strings'), [ - { no: 'v8', yes: 'V8' }, - { no: 'Javascript', yes: 'JavaScript' } + { no: 'Github', yes: 'GitHub' }, + { no: 'Javascript', yes: 'JavaScript' }, + { no: 'Node.JS', yes: 'Node.js' }, + { no: 'v8', yes: 'V8' } ] ], [require('remark-lint-strong-marker'), '*'],