Yay, you're interested in helping this thing suck less. Good for you!
Some things you should be familiar with before getting started
src/- Coffeescript Source filesdist/- Compiled, Concatinated, and Minifiedtest/- Unit Testing Resources
Once you have npm installed, clone the repository (with --recursive to also clone all submodules) and install all dependencies
git clone [email protected] --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.
The test/ directory mirrors the src/ directory for test organization, make
sure to organize and produce tests that fit the patterns present.
npm test
Try your best to follow the present code formatting and patterns in place.
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)
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.