Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1.49 KB
Raw

##Issues

##Pull requests

  • Create a new topic branch for every separate change you make.
  • Create a test case if you are fixing a bug or implementing an important feature.
  • Make sure the build runs successfully.

Development

###Tools We use the following tools for development:

  • Qunit for tests.
  • NodeJS required to run grunt and the test server only.
  • Grunt for task management.

###Getting started Install NodeJS.
Install globally grunt-cli using the following command:

$ npm install -g grunt-cli

Browse to the project root directory and install the dev dependencies:

$ npm install -d

To execute the build and tests run the following command in the root of the project:

$ grunt

You should see a green message in the console:

Done, without errors.

###Tests You can also run the tests in the browser.
Start a test server from the project root:

$ node test/server.js

Open the following URL in a browser:

$ open http://0.0.0.0:8124/test/index.html

Note: we recommend cleaning all the browser cookies before running the tests, that can avoid false positive failures.

###Automatic build You can build automatically after a file change using the following command:

$ grunt watch