Skip to content

Commit

Permalink
Put CONTRIBUTING in its own file
Browse files Browse the repository at this point in the history
  • Loading branch information
passy committed May 10, 2013
1 parent 26d7ea7 commit d9024c9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 25 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
<div class="intro">
# hyperagent.js

hyperagent.js is a JavScript library for consuming [HAL] hypermedia APIs in the
browser.
</div>

## Compatibility

Expand Down Expand Up @@ -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

0 comments on commit d9024c9

Please sign in to comment.