Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.16 KB

Pull Requests are happily accepted, provided that you add or update QUnit tests related to your changes. Also, please update the README documentation, if appropriate.

Development

Please set your editors to use spaces, rather than tabs, (2 spaces per tab) and trim empty lines if possible. We have included an EditorConfig file in the repository so you can configure your favourite editor to use this.

If you want to run your tests, or open the ./tests/index.html page, or:

npm install && npm test

If you want to build the source:

Before building the project, initialize git submodules as follows, otherwise the build script will fail:
git submodule init; git submodule update If you checkout the whole repo with git clone --recursive, that will do the same job.

Run npm install in the root, then run ./scripts/build

Please don't submit pull-requests with the distribution scripts built. By all means, test the build by visiting the page ./tests/distribution.html

If you do build to test, please revert the built files by checking out the original distribution* folders before committing, e.g.

git checkout distribution*

Thanks