Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (36 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.49 KB

Contributing to jQuery Geo

Important notes

Please do not edit files in the dist subdirectory as they are generated via Grunt. You will find source code in the js subdirectory.

Code style

Regarding code style like indentation and whitespace, follow the conventions you see used in the source already.

Please follow jQuery Foundation JavaScript Style Guide and/or idomatic.js.

Submitting pull requests

  1. Create a new branch, please do not work in your master branch directly.
  2. Fix stuff.
  3. Run grunt to verify that your code is lint-free. Repeat steps 2-3 until done.
  4. Update the documentation to reflect any changes.
  5. Push to your fork and submit a pull request.

Building with grunt

  • install node.js ~0.8
  • install grunt-cli (info):
npm install -g grunt-cli
  • uninstall versions of grunt < 0.4.1
  • install grunt 0.4.1 locally into your project folder (info):
cd path/to/geo
npm install grunt
  • install required grunt build tasks locally
npm install grunt-contrib-clean
npm install grunt-contrib-concat
npm install grunt-contrib-uglify
npm install grunt-contrib-jshint
  • run grunt:
grunt

Unless you have downloaded a tagged release, grunt will create a test version of jQuery Geo: dist/jquery.geo-1.0.0-test.min.js