From 6cd27e3e0486ae2bae6a1a583c9759efef48a727 Mon Sep 17 00:00:00 2001 From: David Jarvis Date: Fri, 19 Feb 2016 13:49:12 -0800 Subject: [PATCH] Adding details about links --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9359c2..5ddf0ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,5 +13,10 @@ issues or PRs that simply don't fit our internal engineering needs. PRs to the style guide should include a description of the proposal, including examples of what "good" and "bad" code would look like under the new rule, as well as a rationale for the rule in question. The description of the rule and -the examples belong in `README.md`; the rationale goes in the corresponding -section in `rationales.md` +the examples belong in `README.md`. If the rationale is anything other than "for +consistency", it should go into a corresponding section in `rationales.md`. +Style rules that are purely about consistency do not need rationales. + +Individual rules should include, after the description of the rule, a link to +that rule, and, if a rationale is being added to `rationales.md`, a link to the +detailed rationale.