Skip to content

Commit 16fbd57

Browse files
TrottMylesBorins
authored andcommitted
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: #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>
1 parent 2d857ed commit 16fbd57

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

doc/STYLE_GUIDE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@
99
* The formatting described in `.editorconfig` is preferred.
1010
* A [plugin][] is available for some editors to automatically apply these
1111
rules.
12-
* Mechanical issues, like spelling and grammar, should be identified by tools,
13-
insofar as is possible. If not caught by a tool, they should be pointed out by
14-
human reviewers.
12+
* Changes to documentation should be checked with `make lint-md`.
1513
* American English spelling is preferred. "Capitalize" vs. "Capitalise",
1614
"color" vs. "colour", etc.
1715
* Use [serial commas][].

doc/onboarding.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ onboarding session.
121121
avoid stalling the pull request.
122122
* Note that they are nits when you comment: `Nit: change foo() to bar().`
123123
* If they are stalling the pull request, fix them yourself on merge.
124+
* Insofar as possible, issues should be identified by tools rather than human
125+
reviewers. If you are leaving comments about issues that could be identified
126+
by tools but are not, consider implementing the necessary tooling.
124127
* Minimum wait for comments time
125128
* There is a minimum waiting time which we try to respect for non-trivial
126129
changes, so that people who may have important input in such a distributed

0 commit comments

Comments
 (0)