crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/bower_components/jquery-validation/CONTRIBUTING.md

   1 # Contributing to jQuery Validation Plugin
   2
   3 Thanks for contributing! Here's a few guidelines to help your contribution get landed.
   4
   5 1. Make sure the problem you're addressing is reproducible. Use jsbin.com or jsfiddle.net to provide a test page.
   6 2. Follow the [jQuery style guide](http://contribute.jquery.com/style-guides/js)
   7 3. Add or update unit tests along with your patch. Run the unit tests in at least one browser (see below).
   8 4. Run `grunt` (see below) to check for linting and a few other issues.
   9 5. Describe the change in your commit message and reference the ticket, like this: "Fixed delegate bug for dynamic-totals demo. Fixes #51". If you're adding a new localization file, use something like this: "Added croatian (HR) localization"
  10
  11 ## Build setup
  12
  13 1. Install [NodeJS](http://nodejs.org).
  14 2. Install the Grunt CLI To install by running `npm install -g grunt-cli`. More details are available on their website http://gruntjs.com/getting-started.
  15 3. Install the NPM dependencies by running `npm install`.
  16 4. The build can now be called by running `grunt`.
  17
  18 ## Creating a new Additional Method
  19
  20 If you've wrote custom methods that you'd like to contribute to additional-methods.js:
  21
  22 1. Create a branch
  23 2. Add the method as a new file in src/additional
  24 3. (Optional) Add translations to src/localization
  25 4. Send a pull request to the master branch.
  26
  27 ## Unit Tests
  28
  29 To run unit tests, you should have a local webserver installed and pointing at your workspace. Then open `http://localhost/jquery-validation/test` to run the unit tests. Start with one browser while developing the fix, then run against others before committing. Usually latest Chrome, Firefox, Safari and Opera and a few IEs.
  30
  31 ## Linting
  32
  33 To run JSHint and other tools, use `grunt`.