Skip to content

Latest commit

 

History

History
16 lines (14 loc) · 696 Bytes

CONTRIBUTING.md

File metadata and controls

16 lines (14 loc) · 696 Bytes
Raw

Contributing to DropKick.js

Creating an issue

  • Give a description of the issue and what version of DK.
  • Tell us any other JS that might be running on the same page.
  • Please please provide a JS bin or codepen example. It's the easiest way for us to figure out what's wrong.

Adding or editing code

  • Fork Dropkick
  • Run yarn install to install all the dev dependencies
  • Make your changes
  • Write tests
    • If you're adding a feature write a test for it
    • If you're fixing a bug write a test for it.
  • Run yarn test from your command line. This is to make sure all tests pass.
  • If all tests pass you can create a pull request. Tag any related github issue tickets in the PR.