From e16c8ff2af51a81c7b7120546ac86aa66ec4f73b Mon Sep 17 00:00:00 2001 From: Gabriel Engel Date: Thu, 18 Feb 2016 20:39:33 -0200 Subject: [PATCH] fix typos --- .editorconfig | 3 ++- CONTRIBUTING.md | 16 +++++++++++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/.editorconfig b/.editorconfig index b0d7fd91b35..3abf43ff007 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,4 +1,5 @@ -# editorconfig.org +# EditorConfig is awesome: http://EditorConfig.org + root = true [*] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aeac4e4b3a8..c103c3d1936 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,4 +4,18 @@ The following is a set of guidelines for contributing to Rocket.Chat and its packages, which are hosted in the [Rocket.Chat Organization](https://github.com/RocketChat) on GitHub. -TBD :) +__Note:__ If there's a feature you'd like, there's a bug you'd like to fix, or you'd just like to get involved please raise an issue and start a conversation. We'll help as much as we can so you can get contributing - although we may not always get back right away :) + +## Coding standards + +Most of the coding standards are covered by `.editorconfig`. + +Things not covered by jshint: + +* Unless required __no semicolons__ they are not required +* Short one-line `if` statements do not require nipple brackets (provided functionality is clear) +* Multiple conditionals within an `if` statement should be surrounded by brackets +* `exports`/`module.exports` should be at the end of the file +* Longer, descriptive variable names are preferred, e.g. `error` vs `err` + +We acknowledge all the code does not meet these standards but we are working to change this over time.