QUnit - A JavaScript Unit Testing Framework.

QUnit is a powerful, easy-to-use, JavaScript unit testing framework. It's used by the jQuery project to test its code and plugins but is capable of testing any generic JavaScript code (and even capable of testing JavaScript code on the server-side).

QUnit is especially useful for regression testing: Whenever a bug is reported, write a test that asserts the existence of that particular bug. Then fix it and commit both. Every time you work on the code again, run the tests. If the bug comes up again - a regression - you'll spot it immediately and know how to fix it, because you know what code you just changed.

Having good unit test coverage makes safe refactoring easy and cheap. You can run the tests after each small refactoring step and always know what change broke something.

QUnit is similar to other unit testing frameworks like JUnit, but makes use of the features JavaScript provides and helps with testing code in the browser, e.g. with its stop/start facilities for testing asynchronous code.

If you are interested in helping developing QUnit, you are in the right place. For related discussions, visit the QUnit and Testing forum.

Development

To submit patches, fork the repository, create a branch for the change. Then implement the change, run grunt to lint and test it, then commit, push and create a pull request.

Include some background for the change in the commit message and Fixes #nnn, referring to the issue number you're addressing.

To run grunt, you need node and npm, then npm install grunt -g. That gives you a global grunt binary. For additional grunt tasks, also run npm install.

Releases

Use jquery-release. The following aren't yet handled there:

Install git-extras and run git changelog to update History.md. Clean up the changelog, removing merge commits or whitespace cleanups. Commit this before using the release script.

Then run the script.

Check out the new tag (may need to fetch with git fetch -t), then publish to npm via

npm publish

Update web sites, replacing previous versions with new ones:

• jquery/jquery-wp-content themes/jquery/footer-qunit.php
• jquery/qunitjs.com pages/index.html

Finally announce on Twitter @qunitjs

Released @VERSION: https://github.com/jquery/qunit/tree/@VERSION
Changelog: https://github.com/jquery/qunit/blob/@VERSION/History.md