Skip to content
This repository has been archived by the owner on Feb 10, 2019. It is now read-only.

Contributing

shu8 edited this page Nov 22, 2015 · 1 revision

Everyone is welcome to contribute to the project. I'd love for more features to be added, and even more for bugs to be fixed :P

A few notes on contributing:


  • An issue should be created before a feature is added
  • An issue should be created before a bug fix is made
  • Pull requests will only be merged in the develop branch

When you add a new feature, you must make sure you have done 3 things:

  • New features should be added to the bottom of the functionsToCall object

  • A new feature in the functionsToCall object should have a corresponding checkbox for that feature, that looks like:

      <label><input type='checkbox' id='[FUNCTION NAME]'/> [SHORT DESCRIPTION OF FEATURE]</label> <br />\ 
    
  • A new feature should be added to the README, at the top, with the list of features, and at the bottom, with the descriptions of features

When you fix bugs:

  • Add the bug-fix to the change log on the README.md file, at the bottom of the DEVELOP section
Clone this wiki locally