Developing for Jasmine Core

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 and the developer's list - 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.

General Workflow

Please submit pull requests via feature branches using the semi-standard workflow of:

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Install Dependencies

Jasmine Core relies on Ruby and Node.js.

To install the Ruby dependencies, you will need Ruby, Rubygems, and Bundler available. Then:

$ bundle

...will install all of the Ruby dependencies.

To install the Node dependencies, you will need Node.js, Npm, and Grunt, the grunt-cli and ensure that grunt is on your path.

$ npm install --local

...will install all of the node modules locally. If when you run

$ grunt

...you see that JSHint runs your system is ready.

How to write new Jasmine code

Or, How to make a successful pull request

Do not change the public interface. Lots of projects depend on Jasmine and if you aren't careful you'll break them
Be environment agnostic - server-side developers are just as important as browser developers
Be browser agnostic - if you must rely on browser-specific functionality, please write it in a way that degrades gracefully
Write specs - Jasmine's a testing framework; don't add functionality without test-driving it
Write code in the style of the rest of the repo - Jasmine should look like a cohesive whole
Ensure the entire test suite is green in all the big browsers, Node, and JSHint - your contribution shouldn't break Jasmine for other users

Follow these tips and your pull request, patch, or suggestion is much more likely to be integrated.

Development

All source code belongs in src/. The core/ directory contains the bulk of Jasmine's functionality. This code should remain browser- and environment-agnostic. If your feature or fix cannot be, as mentioned above, please degrade gracefully. Any code that should only be in a non-browser environment should live in src/console/. Any code that depends on a browser (specifically, it expects window to be the global or document is present) should live in src/html/.

Running Specs

Jasmine uses the Jasmine Ruby gem to test itself in browser.

$ rake jasmine

...and then visit http://localhost:8888 to run specs.

Jasmine uses Node.js with a custom runner to test outside of a browser.

$ grunt execSpecsInNode

...and then the results will print to the console. All specs run except those that expect a browser (the specs in spec/html are ignored).

Before Committing or Submitting a Pull Request

Ensure all specs are green in browser and node
Ensure JSHint is green with grunt jsHint
Build jasmine.js with grunt buildDistribution and run all specs again - this ensures that your changes self-test well

3.5 KiB Raw Blame History