Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (25 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.23 KB

Submitting Issues

If you are submitting a bug, please create a jsfiddle demonstrating the issue.

Contributing code

To contribute, fork the library and install grunt and dependencies. You need node; use nvm or nenv to install it.

git clone https://github.com/charneykaye/count.git
cd count
npm install -g grunt-cli
npm install
git checkout develop  # all patches against develop branch, please!
grunt                 # this runs tests and jshint

Very important notes

  • Pull pull requests to the master branch will be closed. Please submit all pull requests to the develop branch.
  • Do not include the minified files in your pull request. Don't worry, we'll build them when we cut a release.

Grunt tasks

We use Grunt for managing the build. Here are some useful Grunt tasks:

  • grunt The default task lints the code and runs the tests. You should make sure you do this before submitting a PR.
  • grunt nodeunit:all Just run the tests.
  • grunt release Build everything, including minified files
  • grunt size Print size statistics.