# How to Contribute

Yay, you're interested in helping this thing suck less.  Good for you!

Some things you should be familiar with before getting started

  - Unit testing (with [QUnit](http://qunitjs.com))
  - [Grunt](http://gruntjs.org)
  - [Node/NPM](https://npmjs.org/) (available via homebrew)

## Project Layout

  - `src/`  - Coffeescript Source files
  - `dist/` - Compiled, Concatinated, and Minified
  - `test/` - Unit Testing Resources


## Development

Once you have npm installed, clone the repository (with `--recursive` to also clone all submodules) and install all dependencies

    git clone git@.....hidpi-canvas-polyfill.git --recursive
    cd hidpi-canvas-polyfill
    npm install

Then to build a distribution run

    npm run build

This will generate the compiled (and minified) sourc in your `dist/` directory
along with a distributable zip archive.

Any time you change any of the `src/**/*.js` files you'll
need to re-run this command.

You can also use

    npm run watch

to automatically reconcat the unminified file everytime you
change any of the `src/**/*.js` files.

## Testing

### Writing Tests

The `test/` directory mirrors the `src/` directory for test organization, make
sure to organize and produce tests that fit the patterns present.

### Running Tests

    npm test

## On Contribution

### Be a Chameleon

Try your best to follow the present code formatting and patterns in place.

### Pull Requests

**Make sure to send pull requests to develop.**

Good Pull Requests include:

  - A clear explaination of the problem (or enhancement)
  - Clean commit history (squash where it makes sense)
  - Relevant Tests (either updated and/or new)

# TODO

A few things it currently lacks that I'd like to see improved

  - More complete canvas context method coverage.
  - Figure out how to test this stuff.