From 24e50a48344ac38dc49af75aa7661377282ce0cd Mon Sep 17 00:00:00 2001 From: Phil Crosby Date: Sun, 19 Oct 2014 22:54:27 -0700 Subject: Add some style advice These represent common feedback given on PRs --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03ac26e9..41ce7736 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,6 +59,15 @@ reports: * We follow two major differences from this style guide: * Wrap lines at 110 characters instead of 80. * Use double-quoted strings by default. + * When writing comments, uppercase the first letter of your sentence, and put a period at the end. + * If you have a short conditional, feel free to put it on one line: + + # No + if i < 10 + return + + # Yes + return if i < 10 ## Pull Requests -- cgit v1.2.3