Developers Guide

Workflow

History.js uses the following workflow: http://nvie.com/posts/a-successful-git-branching-model/ - it may seem daunting, but it's actually rather easy. First we work on the dev branch, it is rarely stable. If it does become stable, then we push it to a feature branch, and the master branch corresponds to the latest stable feature branch.

Testing

Adding a Test

Tests are located in the tests/test.js file. The testing framework is QUnit. Please ensure that the tests still run if you have made a change.

Running the Tests

Once that is done, navigate to the history.js/tests directory on your webserver in your browser. You will be presented with a series of options. Please test in all adapters, and in all supported browsers (see the readme).

Submitting

License

Before you submit your code for integration, be sure to specify which license it is under. History.js currently accepts either the New-BSD license or the MIT license.

Pull Request

To submit your changes, you will submit a pull request via Github. This can be done via the "Pull Requests" tab on your fork. Please describe in detail what your changes fixes/adds, which tests pass and fail, and in which browsers have you test it in.

Thanks

If you anything is confusing or if you would like some help feel free to add my on Skype (username balupton) and I'll be glad to help you out :)

Cheers,

• Benjamin