From d9024c9abe32e5d68270f13fc7c1fc83306c008e Mon Sep 17 00:00:00 2001 From: Pascal Hartig Date: Fri, 10 May 2013 15:51:34 +0200 Subject: [PATCH] Put CONTRIBUTING in its own file --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ README.md | 27 ++------------------------- 2 files changed, 26 insertions(+), 25 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6f5759b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +To set up the development environment, install the dependencies with npm and +bower: + +```bash +npm install --dev +bower install --dev +``` + +Start the development server that transpiles the module as you modify them: + +```bash +grunt server +``` + +Make sure to test your changes and run `grunt test` to run the suite in +PhantomJS, Chrome and Firefox. Your code should follow the fit the style of the +project, which is roughly based on +[Crockford's white space rules](http://javascript.crockford.com/code.html). + +When done with your changes, push them to a feature branch, open a [pull +request](http://github.com/passy/hyperagent.js/issues/) and enjoy our infinite +gratitude. diff --git a/README.md b/README.md index b12da6a..8c5fe4c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ +
# hyperagent.js hyperagent.js is a JavScript library for consuming [HAL] hypermedia APIs in the browser. +
## Compatibility @@ -299,31 +301,6 @@ callback-based API. [RFC6570]: http://tools.ietf.org/html/rfc6570 [HAL]: http://tools.ietf.org/html/draft-kelly-json-hal-05 -## Contributing - -To set up the development environment, install the dependencies with npm and -bower: - -```bash -npm install --dev -bower install --dev -``` - -Start the development server that transpiles the module as you modify them: - -```bash -grunt server -``` - -Make sure to test your changes and run `grunt test` to run the suite in -PhantomJS, Chrome and Firefox. Your code should follow the fit the style of the -project, which is roughly based on -[Crockford's white space rules](http://javascript.crockford.com/code.html). - -When done with your changes, push them to a feature branch, open a [pull -request](http://github.com/passy/hyperagent.js/issues/) and enjoy our infinite -gratitude. - ## License Licensed under MIT