Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.03 KB
Raw

How to Contribute

Yay, you're interested in helping work on this project. Thank you!

Project Layout

  • src/ - JavaScript Source
  • dist/ - Compiled and Minified
  • docs/ - Example test cases in browser and publishes to GitHub Pages

Having a problem?

A great way to start a discussion about a potential issue is to submit an issue with the device, OS, and browser info.

Have an idea to make it better?

Again, guard your time and effort. Make sure that you don't spend a lot of time on an improvement without talking through it first.

Getting to work

npm install
npm run gulp watch

When you edit and save the files in the src/ directory it will recompile and drop the files into the dist/ directory.

Pull Requests

Good Pull Requests include:

  • A clear explaination of the problem (or enhancement)
  • Clean commit history (squash where it makes sense)
  • Relevant Explination of how to test

Thanks to Payform for the contribution template.