From 23fd08ec7abfc88525e4acc0b0d5bf250e49f9ad Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 25 Dec 2017 14:27:33 -0800 Subject: [PATCH 1/4] doc: remove non-style information from style guide While I agree that tools should be used insofar as possible, that information does not belong in the style guide. --- doc/STYLE_GUIDE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index d1bf5208595c20..6e84ce3c2a037e 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -9,9 +9,6 @@ * 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. * American English spelling is preferred. "Capitalize" vs. "Capitalise", "color" vs. "colour", etc. * Use [serial commas][]. From 295ae9b6bff0077b07f0f51be4c1f4df2b8b2b88 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 27 Dec 2017 13:31:31 -0800 Subject: [PATCH 2/4] squash --- doc/STYLE_GUIDE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 6e84ce3c2a037e..8ea9c8fe81b732 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -9,6 +9,7 @@ * The formatting described in `.editorconfig` is preferred. * A [plugin][] is available for some editors to automatically apply these rules. +* 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][]. From beaafb3990f8f75b992a6acabe99fb80b1b1fd29 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 29 Dec 2017 16:05:27 -0800 Subject: [PATCH 3/4] squash: add note to onboarding doc --- doc/onboarding.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/onboarding.md b/doc/onboarding.md index 1491b5ee9e4e1a..c27da75536c56d 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 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 From 02ec302e6e6429a17c2c9c8b5d36f7c69c8bd4f2 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 29 Dec 2017 20:13:56 -0800 Subject: [PATCH 4/4] squash --- doc/onboarding.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/onboarding.md b/doc/onboarding.md index c27da75536c56d..e67f6638d3a0e4 100644 --- a/doc/onboarding.md +++ b/doc/onboarding.md @@ -122,8 +122,8 @@ onboarding session. * 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 that could be identified by tools but - are not, consider implementing the necessary tooling. + 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