Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Contributing

Jump to bottom
Alex Vernacchia edited this page Jun 27, 2015 · 5 revisions

We welcome all contributions! We just ask that you follow some simple guidelines.

  1. Use tabs, not spaces
  2. Before all pull requests:
    1. Run grunt jshint before submitting pull requests
      • Checkout our .jshintrc for the conventions we use
    2. Rebase commits into manageable chunks relevant to contributed functionality
      • Please use descriptive commit messages. Take a look at the projects past commit messages to get a feel
    3. Write tests, if you've added functionality that the current tests don't cover
      • Tests are written in mocha. To generate coverage --> istanbul cover _mocha test/
      • I've include the test coverage below. It should stay the same, or go up (never down)

Coverage as of June 27th, 2015

=============================== Coverage summary ===============================
Statements   : 100% ( 68/68 )
Branches     : 98% ( 49/50 )
Functions    : 100% ( 11/11 )
Lines        : 100% ( 68/68 )
================================================================================
Clone this wiki locally