From 75fb19bc49e642511a413ba3cbbdf48b19be046f Mon Sep 17 00:00:00 2001 From: "Davis W. Frank" Date: Wed, 9 Mar 2011 08:16:47 -0800 Subject: [PATCH] README changes --- HowToContribute.markdown | 25 ------------------------- MIT.LICENSE | 2 +- README.markdown | 29 +++++++++++++++++++++++------ 3 files changed, 24 insertions(+), 32 deletions(-) delete mode 100644 HowToContribute.markdown diff --git a/HowToContribute.markdown b/HowToContribute.markdown deleted file mode 100644 index ca7b29b..0000000 --- a/HowToContribute.markdown +++ /dev/null @@ -1,25 +0,0 @@ -# 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. - diff --git a/MIT.LICENSE b/MIT.LICENSE index 1eb9b49..7c435ba 100644 --- a/MIT.LICENSE +++ b/MIT.LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2008-2010 Pivotal Labs +Copyright (c) 2008-2011 Pivotal Labs Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.markdown b/README.markdown index 3818ed8..1e74d75 100644 --- a/README.markdown +++ b/README.markdown @@ -14,15 +14,32 @@ Documentation & guides live here: [http://pivotal.github.com/jasmine/](http://pi * 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 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. 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. + +### 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 + +* __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 -## Developers - -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.