Updating docs. Version goes to 1.1.0
This commit is contained in:
Davis W. Frank
parent
fc994108db
commit
6ec825f62d
25
HowToContribute.markdown
Normal file
25
HowToContribute.markdown
Normal file
@ -0,0 +1,25 @@
|
||||
# Jasmine Contributor's Guide
|
||||
|
||||
We welcome your contributions. Whether it's working on a story on the backlog, adding a missing feature or fixing a bug thanks for helping making Jasmine a better project for everyone.
|
||||
|
||||
## Development Environment
|
||||
|
||||
Jasmine Core relies on Ruby for executing the test suite and building the project for release. If you're contributing
|
||||
|
||||
The project also relies on [Node.js](http://nodejs.org) in order to run Jasmine's suite in an environment outside a browser.
|
||||
|
||||
## How to Develop for Jasmine Core
|
||||
|
||||
* Write specs
|
||||
* Make them pass in a browser (or three): open `spec/runner.html`
|
||||
* Make them pass in Node: `node spec/node_suite.js`
|
||||
* Fix any warnings or errors from JSHint: `rake jasmine:lint`
|
||||
|
||||
## Making a Successful Pull Request
|
||||
|
||||
All pull requests should come through Github's system.
|
||||
|
||||
We welcome discussion of your proposed changes on the developers' list before you submit. It's not required, but we're pretty good about giving feedback.
|
||||
|
||||
Pull requests should include specs and the full test suite should be green: in all the big browsers, Node, and JSHint. There are `rake` tasks to help with this.
|
||||
|
||||
@ -1,31 +1,29 @@
|
||||
# Making a Release of Jasmine Core
|
||||
|
||||
Jasmine Core is this Github repo and contains all the core JavaScript code for the Jasmine BDD framework.
|
||||
'Jasmine' is the Github repo for Jasmine Core and contains all the JavaScript code for the Jasmine BDD framework.
|
||||
|
||||
It also contains two HTML pages for the Github Pages at http://pivotal.github.com/jasmine.
|
||||
|
||||
## The Repo
|
||||
|
||||
All of the JS for Jasmine is in the src directory. The specs for each file are in the specs directory. There are rake
|
||||
tasks to concat all these files in the correct order.
|
||||
|
||||
## The Pages
|
||||
|
||||
Github pages have to exist in a branch called gh-pages in order for their app to serve them. This repo adds that
|
||||
branch as a submodule under the `pages` directory. This is a bit of a hack, but it allows us to work with the pages
|
||||
and the source at the same time and with one set of rake tasks.
|
||||
|
||||
If you want to submit changes to this repo and aren't a Pivotal Labs employee, you can fork and work in the gh-pages
|
||||
branch. You won't be able to edit the pages in the submodule off of master.
|
||||
|
||||
The pages are built with [Frank](https://github.com/blahed/frank). All the source for these pages live in the
|
||||
pages_source directory.
|
||||
All of the JS for Jasmine is in the src directory. The specs for each file are in the specs directory. There are rake tasks to build the various files for distribution.
|
||||
|
||||
## Running Specs
|
||||
|
||||
Open the file `spec/runner.html` and all specs will run.
|
||||
There are rake tasks to help with getting green:
|
||||
|
||||
* `rake spec:browser` opens `spec/runner.html` in the default browser. Please run this in at least Firefox and Chrome before comitting
|
||||
* `rake spec:node` runs all the Jasmine specs in Node.js
|
||||
* `rake jasmine:lint` runs all the files through JSHint and will complain about potential viable issues with your code. Fix them.
|
||||
|
||||
## The Pages
|
||||
|
||||
Github pages have to exist in a branch called gh-pages in order for their app to serve them. This repo adds that branch as a submodule under the `pages` directory. This is a bit of a hack, but it allows us to work with the pages and the source at the same time and with one set of rake tasks.
|
||||
|
||||
If you want to submit changes to this repo and aren't a Pivotal Labs employee, you can fork and work in the gh-pages branch. You won't be able to edit the pages in the submodule off of master.
|
||||
|
||||
The pages are built with [Frank](https://github.com/blahed/frank). All the source for these pages live in the pages_source directory.
|
||||
|
||||
## Releasing
|
||||
|
||||
Once all specs are green and you've updated the version in `version.json`, you need to run the rake task to make a
|
||||
distribution: `rake jasmine:dist`.
|
||||
Once all specs are green and you've updated the version in `version.json`, you need to run the rake task to make a distribution: `rake jasmine:dist`.
|
||||
|
||||
@ -2,27 +2,27 @@
|
||||
=======
|
||||
**A JavaScript Testing Framework**
|
||||
|
||||
Want to use Jasmine in a project? Go HERE: [http://pivotal.github.com/jasmine/](http://pivotal.github.com/jasmine/)
|
||||
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.
|
||||
|
||||
Want to contribute to Jasmine? Read on...
|
||||
|
||||
<i>(More developer docs to come...)</i>
|
||||
Documentation & guides live here: [http://pivotal.github.com/jasmine/](http://pivotal.github.com/jasmine/)
|
||||
|
||||
## Support
|
||||
We now have a Google Group for support & discussion.
|
||||
|
||||
* Discussion: [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)
|
||||
* Group email: [jasmine-js@googlegroups.com](jasmine-js@googlegroups.com)
|
||||
* Current build status of Jasmine is visible at [ci.pivotallabs.com](http://ci.pivotallabs.com)
|
||||
* Pivotal Tracker project: [http://www.pivotaltracker.com/projects/10606](http://www.pivotaltracker.com/projects/10606)
|
||||
* Twitter: [@JasmineBDD](http://twitter.com/JasmineBDD)
|
||||
* 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)
|
||||
|
||||
## Maintainers
|
||||
* [Davis W. Frank](mailto:dwfrank@pivotallabs.com), Pivotal Labs
|
||||
* [Rajan Agaskar](mailto:rajan@pivotallabs.com), Pivotal Labs
|
||||
* [Christian Williams](mailto:xian@pivotallabs.com), Pivotal Labs
|
||||
* [Christian Williams](mailto:antixian666@gmail.com), Square
|
||||
|
||||
## Developers
|
||||
We welcome your contributions! Jasmine is currently maintained by Davis Frank ([infews](http://github.com/infews)), Rajan Agaskar ([ragaskar](http://github.com/ragaskar)), and Christian Williams ([Xian](http://github.com/Xian)). You can help us by removing all other recipients from your pull request.
|
||||
|
||||
Copyright (c) 2008-2010 Pivotal Labs. This software is licensed under the MIT License.
|
||||
We welcome your contributions. Please review the backlog and discussion lists (the main group and the developer's list at [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)) before starting work - what you're looking for may already have been done.
|
||||
|
||||
Please read the contributor's guide before starting work and before sending your pull request.
|
||||
|
||||
Copyright (c) 2008-2011 Pivotal Labs. This software is licensed under the MIT License.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"major": 1,
|
||||
"minor": 0,
|
||||
"build": 2
|
||||
"minor": 1,
|
||||
"build": 0
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user