First of all, thanks! Community contribution is what makes open source great. If you find a bug or would like to make a feature request, please report it on the issue tracker. If you would like to make changes to the code yourself, read on!
To get started with hacking on Rekapi, you'll need to get all of the dependencies with Bower (version 1.0 or later) and npm (and, by extension, Node):
$: bower install; npm install
Rekapi uses SemVer for versioning. If you modify the
source code, please adhere to this convention (in all likelihood you will only
need to modify the rightmost digit by one). To change the version, you'll need
to update the version in two places: bower.json and package.json (look for
the lines that say version). The version numbers in these two files must be
kept in sync.
Rekapi uses Grunt (version 0.4.1 or later, globally installed) to generate the distributable binaries. If you make any changes to the source code, please rebuild the binaries with:
$: grunt build
A note about the dist/ directory: You should not modify the files in this
directory manually, as your changes will be overwritten by the build process.
The Rekapi source files are in src/ and the various ext/ extension
directories. dist/doc/ contains the documentation pages generated by
dox-foundation. Other
subdirectories in dist/ contain various static assets copied from the
dependencies that are used by the HTML files.
Please make sure that all tests pass before submitting a Pull Request. To run the tests on the command line (requires PhantomJS):
$: grunt qunit
You can also run the tests in the browser. They are in tests/. If you are
adding a feature or fixing a bug, please add a test!
Please adhere to the style guide. To automatically check for style issues or other potential problems, you can run:
$: grunt jshint