diff options
| author | Rich Trott <rtrott@gmail.com> | 2017-12-25 14:27:33 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-01-02 21:33:32 -0800 |
| commit | f51067a85d64b77f2eae2e099092209156d6e602 (patch) | |
| tree | cb53178ae5b1372ed37f5249d777785ec10cf5e1 /doc | |
| parent | f05fb0104a01ee852f673856ab5aa0ca69201523 (diff) | |
| download | android-node-v8-f51067a85d64b77f2eae2e099092209156d6e602.tar.gz android-node-v8-f51067a85d64b77f2eae2e099092209156d6e602.tar.bz2 android-node-v8-f51067a85d64b77f2eae2e099092209156d6e602.zip | |
doc: remove non-style information from style guide
While tools should be used insofar as possible, that information
does not belong in the style guide. Move to onboarding doc.
PR-URL: https://github.com/nodejs/node/pull/17866
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 4 | ||||
| -rw-r--r-- | doc/onboarding.md | 3 |
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index d1bf520859..8ea9c8fe81 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -9,9 +9,7 @@ * The formatting described in `.editorconfig` is preferred. * A [plugin][] is available for some editors to automatically apply these rules. -* Mechanical issues, like spelling and grammar, should be identified by tools, - insofar as is possible. If not caught by a tool, they should be pointed out by - human reviewers. +* Changes to documentation should be checked with `make lint-md`. * American English spelling is preferred. "Capitalize" vs. "Capitalise", "color" vs. "colour", etc. * Use [serial commas][]. diff --git a/doc/onboarding.md b/doc/onboarding.md index 1491b5ee9e..e67f6638d3 100644 --- a/doc/onboarding.md +++ b/doc/onboarding.md @@ -121,6 +121,9 @@ onboarding session. avoid stalling the pull request. * Note that they are nits when you comment: `Nit: change foo() to bar().` * If they are stalling the pull request, fix them yourself on merge. +* Insofar as possible, issues should be identified by tools rather than human + reviewers. If you are leaving comments about issues that could be identified + by tools but are not, consider implementing the necessary tooling. * Minimum wait for comments time * There is a minimum waiting time which we try to respect for non-trivial changes, so that people who may have important input in such a distributed |