jasmine/README.markdown

<a name="README">[Jasmine](http://pivotal.github.com/jasmine/)</a>
=======
**A JavaScript Testing Framework**

Jasmine is a Behavior Driven Development testing framework for JavaScript. It does not rely on browsers, DOM, or any JavaScript framework. Thus it's suited for websites, [Node.js](http://nodejs.org) projects, or anywhere that JavaScript can run.

Documentation & guides live here: [http://pivotal.github.com/jasmine/](http://pivotal.github.com/jasmine/)

## Support

* Search past discussions: [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)
* Send an email to the list: [jasmine-js@googlegroups.com](jasmine-js@googlegroups.com)
* Check the current build status: [ci.pivotallabs.com](http://ci.pivotallabs.com)
* View the project backlog at Pivotal Tracker: [http://www.pivotaltracker.com/projects/10606](http://www.pivotaltracker.com/projects/10606)
* Follow us on Twitter: [@JasmineBDD](http://twitter.com/JasmineBDD)

## How to Contribute

We welcome your contributions - Thanks for helping make Jasmine a better project for everyone. Please review the backlog and discussion lists (the main group - [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js) and the developer's list - [http://groups.google.com/group/jasmine-js-dev](http://groups.google.com/group/jasmine-js-dev)) before starting work - what you're looking for may already have been done. If it hasn't, the community can help make your contribution better.

### Development Environment

Jasmine Core relies on Ruby for executing the test suite and building the project for release. The spec suite runs in any major, modern browser (Firefox, Safari, Chrome, and yes various IE's) and in [Node.js](http://nodejs.org). While you probably have browsers installed, you want to make sure that Ruby and Node are present.

### How to Develop for Jasmine Core

* Write specs
* Make them pass in a browser (or three):
  * open `spec/runner.html` in your browsers
  * `rake spec:browser` will run in the default browser on MacOS
* Make them pass in Node: `rake spec:node`
* Fix any warnings or errors from JSHint: `rake jasmine:lint`

Running `rake spec` will run the browser tests, then run specs in Node, then run JSHint. But this will only run in the default browser and only on MacOS (for now).


### Making a Successful Pull Request

* __Include specs for your work__ - it helps us understand your intent and makes sure that future development doesn't break your work
* __Ensure the full test suite is green__ in all the big browsers, Node, and JSHint - your contribution shouldn't break Jasmine for other users

Do these things and we'll take a look.

## Maintainers

* [Davis W. Frank](mailto:dwfrank@pivotallabs.com), Pivotal Labs
* [Rajan Agaskar](mailto:rajan@pivotallabs.com), Pivotal Labs
* [Christian Williams](mailto:antixian666@gmail.com), Square

Copyright (c) 2008-2011 Pivotal Labs. This software is licensed under the MIT License.
Styling. 2010-07-24 01:25:21 +00:00			`<a name="README">[Jasmine](http://pivotal.github.com/jasmine/)</a>`
dwf: small cleanups. 2008-12-03 03:59:13 +00:00			`=======`
Update why-did-we-write-it sections. 2010-02-26 02:56:42 +00:00			`A JavaScript Testing Framework`
dwf: small cleanups. 2008-12-03 03:59:13 +00:00
Updating docs. Version goes to 1.1.0 2011-03-09 02:39:13 +00:00			`Jasmine is a Behavior Driven Development testing framework for JavaScript. It does not rely on browsers, DOM, or any JavaScript framework. Thus it's suited for websites, [Node.js](http://nodejs.org) projects, or anywhere that JavaScript can run.`
Documentation updates. 2009-09-10 01:46:29 +00:00
Updating docs. Version goes to 1.1.0 2011-03-09 02:39:13 +00:00			`Documentation & guides live here: [http://pivotal.github.com/jasmine/](http://pivotal.github.com/jasmine/)`
Update why-did-we-write-it sections. 2010-02-26 02:56:42 +00:00
proxying dwf README changes. 2009-03-01 14:55:39 +00:00			`## Support`

Updating docs. Version goes to 1.1.0 2011-03-09 02:39:13 +00:00			`* Search past discussions: [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)`
			`* Send an email to the list: [jasmine-js@googlegroups.com](jasmine-js@googlegroups.com)`
			`* Check the current build status: [ci.pivotallabs.com](http://ci.pivotallabs.com)`
			`* View the project backlog at Pivotal Tracker: [http://www.pivotaltracker.com/projects/10606](http://www.pivotaltracker.com/projects/10606)`
			`* Follow us on Twitter: [@JasmineBDD](http://twitter.com/JasmineBDD)`
proxying dwf README changes. 2009-03-01 14:55:39 +00:00
README changes 2011-03-09 16:16:47 +00:00			`## How to Contribute`

More README edits for the Contributor guide 2011-03-09 21:31:03 +00:00			We welcome your contributions - Thanks for helping make Jasmine a better project for everyone. Please review the backlog and discussion lists (the main group - [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js) and the developer's list - [http://groups.google.com/group/jasmine-js-dev](http://groups.google.com/group/jasmine-js-dev)) before starting work - what you're looking for may already have been done. If it hasn't, the community can help make your contribution better.
README changes 2011-03-09 16:16:47 +00:00
			`### Development Environment`

More README edits for the Contributor guide 2011-03-09 21:31:03 +00:00			`Jasmine Core relies on Ruby for executing the test suite and building the project for release. The spec suite runs in any major, modern browser (Firefox, Safari, Chrome, and yes various IE's) and in [Node.js](http://nodejs.org). While you probably have browsers installed, you want to make sure that Ruby and Node are present.`
README changes 2011-03-09 16:16:47 +00:00
			`### How to Develop for Jasmine Core`

			`* Write specs`
One more README tweak 2011-03-09 21:15:33 +00:00			`* Make them pass in a browser (or three):`
			* open `spec/runner.html` in your browsers
			* `rake spec:browser` will run in the default browser on MacOS
			* Make them pass in Node: `rake spec:node`
README changes 2011-03-09 16:16:47 +00:00			* Fix any warnings or errors from JSHint: `rake jasmine:lint`

One more README tweak 2011-03-09 21:15:33 +00:00			Running `rake spec` will run the browser tests, then run specs in Node, then run JSHint. But this will only run in the default browser and only on MacOS (for now).


README changes 2011-03-09 16:16:47 +00:00			`### Making a Successful Pull Request`

			`* __Include specs for your work__ - it helps us understand your intent and makes sure that future development doesn't break your work`
			`* __Ensure the full test suite is green__ in all the big browsers, Node, and JSHint - your contribution shouldn't break Jasmine for other users`

			`Do these things and we'll take a look.`

dwf/rva: minor Jasmine cleanup 2008-12-04 00:23:17 +00:00			`## Maintainers`
README changes 2011-03-09 16:16:47 +00:00
Documentation updates. 2009-09-10 01:46:29 +00:00			`* [Davis W. Frank](mailto:dwfrank@pivotallabs.com), Pivotal Labs`
			`* [Rajan Agaskar](mailto:rajan@pivotallabs.com), Pivotal Labs`
Updating docs. Version goes to 1.1.0 2011-03-09 02:39:13 +00:00			`* [Christian Williams](mailto:antixian666@gmail.com), Square`
dwf/rva: minor Jasmine cleanup 2008-12-04 00:23:17 +00:00
Updating docs. Version goes to 1.1.0 2011-03-09 02:39:13 +00:00			`Copyright (c) 2008-2011 Pivotal Labs. This software is licensed under the MIT License.`