edc2bfae93
Canonical Jasmine version now lives in `package.json` (Node formatted) and is copied into Jasmine source (JavaScript and Ruby) Jasmine distribution now has MIT license and Pivotal Labs copyright at the top of each distributed file.
80 lines
3.9 KiB
Markdown
80 lines
3.9 KiB
Markdown
# 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](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.
|
|
|
|
## General Workflow
|
|
|
|
Please submit pull requests via feature branches using the semi-standard workflow of:
|
|
|
|
1. Fork it
|
|
1. Create your feature branch (`git checkout -b my-new-feature`)
|
|
1. Commit your changes (`git commit -am 'Add some feature'`)
|
|
1. Push to the branch (`git push origin my-new-feature`)
|
|
1. 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](http://gruntjs.com/) (including the grunt-cli).
|
|
|
|
$ 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 a Node
|
|
|
|
and uses a custom runner for node.
|
|
|
|
Tests in Bro
|
|
|
|
As in all good projects, the `spec/` directory mirrors `src/` and follows the same rules. The browser runner will include and attempt to run all specs. The node runner will exclude any html-dependent specs (those in `spec/html/`).
|
|
|
|
You will notice that all specs are run against the built `jasmine.js` instead of the component source files. This is intentional as a way to ensure that the concatenation code is working correctly.
|
|
|
|
Please ensure all specs are green before committing or issuing a pull request.
|
|
|
|
There are Thor tasks to help with getting green - run `thor list` to see them all. Here are the key tasks:
|
|
|
|
* `thor jasmine_dev:execute_specs` outputs the expected number of specs that should be run and attempts to run in browser and Node
|
|
* `thor jasmine_dev:execute_specs_in_browser` opens `spec/runner.html` in the default browser on MacOS. Please run this in at least Firefox and Chrome before committing
|
|
* `thor jasmine_dev:execute_specs_in_node` runs all the Jasmine specs in Node.js - it will complain if Node is not installed
|
|
|