Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 49 lines (35 sloc) 2.243 kB
f7dab0d @jzaefferer Adding readme. Fixes #58
jzaefferer authored
1 [QUnit](http://docs.jquery.com/QUnit) - A JavaScript Unit Testing framework.
2 ================================
3
4 QUnit is a powerful, easy-to-use, JavaScript test suite. It's used by the jQuery
5 project to test its code and plugins but is capable of testing any generic
6 JavaScript code (and even capable of testing JavaScript code on the server-side).
7
8 QUnit is especially useful for regression testing: Whenever a bug is reported,
9 write a test that asserts the existence of that particular bug. Then fix it and
10 commit both. Every time you work on the code again, run the tests. If the bug
11 comes up again - a regression - you'll spot it immediately and know how to fix
12 it, because you know what code you just changed.
13
14 Having good unit test coverage makes safe refactoring easy and cheap. You can
15 run the tests after each small refactoring step and always know what change
16 broke something.
17
18 QUnit is similar to other unit testing frameworks like JUnit, but makes use of
f962600 @Erkan-Yilmaz typo
Erkan-Yilmaz authored
19 the features JavaScript provides and helps with testing code in the browser, e.g.
20 with its stop/start facilities for testing asynchronous code.
f7dab0d @jzaefferer Adding readme. Fixes #58
jzaefferer authored
21
22 If you are interested in helping developing QUnit, you are in the right place.
23 For related discussions, visit the
24 [QUnit and Testing forum](http://forum.jquery.com/qunit-and-testing).
b061e22 @jzaefferer Point to planning testing wiki in readme
jzaefferer authored
25
26 Planning for a qunitjs.com site and other testing tools related work now happens
27 on the [jQuery Testing Team planning wiki](http://jquerytesting.pbworks.com/w/page/41556026/FrontPage).
28eda07 @jzaefferer Update readme with basic notes on releases
jzaefferer authored
28
34b0831 @jzaefferer Add grunt.js configuration and include some usage instructions in the…
jzaefferer authored
29 Development
30 -----------
31
32 To submit patches, fork the repository, create a branch for the change. Then implement
33 the change, run `grunt` to lint and test it, then commit, push and create a pull request.
34
35 Include some background for the change in the commit message and `Fixes #nnn`, referring
36 to the issue number you're addressing.
37
38 To run `grunt`, you need `node` and `npm`, then `npm install grunt -g`.
39
28eda07 @jzaefferer Update readme with basic notes on releases
jzaefferer authored
40 Releases
41 --------
42
43 Install git-extras and run `git changelog` to update History.md.
44 Update qunit/qunit.js|css to the release version, commit and tag, update them
45 again to the next version, commit and push commits and tags.
bae17fe @jzaefferer Extend readme regarding release process
jzaefferer authored
46
47 Put the 'v' in front of the tag (unlike the 1.1.0 release). Clean up the changelog,
48 removing merge commits or whitespace cleanups.
Something went wrong with that request. Please try again.