Contributing to editor-framework

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to editor-framework and its packages.

Coding Style Guide

editor-framework recommend a tab size of 2 spaces.
use dash naming rules for files and folders ( e.g. foo-bar )
use camelCase naming rules for module methods and properties ( e.g. fooBar )
use CamelCase naming rules for modules ( e.g. FooBar )
use upper-case for the first character of required module ( e.g. var Foo = require('foo') )
use _ prefix for private method or variables ( e.g. var _foobar = 'FooBar' )

Recommend Ipc message in the form of module-name:ipc-channel-name ( e.g. foo-bar:say-hello)
Recommend DOM event in Polymer in the form of _onMyEvent ( e.g. <foobar on-click="_onClick" />)

Include the version of editor-framework you are using and the OS.
Include screenshots and animated GIFs whenever possible; they are immensely helpful.
Check the dev tools (alt-cmd-i) for errors to include. If the dev tools are open before the error is triggered, a full stack trace for the error will be logged. If you can reproduce the error, use this approach to get the full stack trace and include it in the issue.
On Mac, check Console.app for stack traces to include if reporting a crash.
Perform a cursory search to see if a similar issue has already been submitted.
Please setup a profile picture to make yourself recognizable and so we can all get to know each other better.

Include screenshots and animated GIFs in your pull request whenever possible.
JavaScript, and CSS styleguides.
Include thoughtfully-worded, well-structured Mocha specs. See Editor-Framework tests for example.
Document new code with comments in source code based on the Firedoc User Guide
End files with a newline.
Place requires in the following order:
- Built in Node Modules (such as path)
- Built in editor-framework and Electron Modules (such as fire-fs, shell)
- Local Modules (using relative paths)
Place class properties in the following order:
- Class methods and properties (methods starting with a @)
- Instance methods and properties
Avoid platform-dependent code:
- Use require('atom').fs.getHomeDirectory() to get the home directory.
- Use path.join() to concatenate filenames.
- Use os.tmpdir() rather than /tmp when you need to reference the temporary directory.
Using a plain return when returning explicitly at the end of a function.
- Not return null, return undefined, null, or undefined