aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhil Crosby2014-10-19 22:54:27 -0700
committerPhil Crosby2014-10-19 22:54:27 -0700
commit24e50a48344ac38dc49af75aa7661377282ce0cd (patch)
treecd3ebe85ba7d582d4935c7423d849f8b2365f244
parentb42f4c9e176ec382c67ba255dad9412dd37eaffa (diff)
downloadvimium-24e50a48344ac38dc49af75aa7661377282ce0cd.tar.bz2
Add some style advice
These represent common feedback given on PRs
-rw-r--r--CONTRIBUTING.md9
1 files changed, 9 insertions, 0 deletions
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