forked from jasmine/jasmine
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating docs. Version goes to 1.1.0
- Loading branch information
Davis W. Frank
committed
Mar 9, 2011
1 parent
fc99410
commit 6ec825f
Showing
4 changed files
with
53 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
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. | ||
|
||
## The Pages | ||
## Running Specs | ||
|
||
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. | ||
There are rake tasks to help with getting green: | ||
|
||
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. | ||
* `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 are built with [Frank](https://github.com/blahed/frank). All the source for these pages live in the | ||
pages_source directory. | ||
## The Pages | ||
|
||
## Running Specs | ||
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. | ||
|
||
Open the file `spec/runner.html` and all specs will run. | ||
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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"major": 1, | ||
"minor": 0, | ||
"build": 2 | ||
"minor": 1, | ||
"build": 0 | ||
} |