Permalink
Browse files

Add notes about coding conventions, EditorConfig and using CoffeeScri…

…pt in examples
  • Loading branch information...
1 parent 96347a6 commit 2356a9b024d3587f02f79d81156ee876487da4a4 @cobbweb cobbweb committed Jan 13, 2014
Showing with 9 additions and 0 deletions.
  1. +9 −0 CONTRIBUTING.md
View
@@ -32,6 +32,11 @@ itself is not usually sufficient. There needs to be some
context and purpose with it, and it should be done
against specific branch.
+Try and stick to Marionette's existing coding conventions
+(just use the file your editing as a guideline).
+Installing the appropriate [EditorConfig plugin](http://editorconfig.org/#download)
+for your code editor will help with this.
+
## General Submission Guidelines
These guidelines are generally applicable whether or not
@@ -83,6 +88,10 @@ Without at least the first 2 items in this list, we won't
have any clue why you're changing the code. The first thing
we'll ask, then, is that you add that information.
+Please refrain from giving code examples in altJS langauges like
+CoffeeScript, etc. Marionette is written in plain-old JavaScript
+and is generally easier all members in the community to read.
+
### Create A Topic Branch For Your Work
The work you are doing for your pull request should not be

0 comments on commit 2356a9b

Please sign in to comment.