Skip to content

Commit 58cff9d

Browse files
committed
Add contributing.md, should help land PRs a little faster
1 parent 710b17c commit 58cff9d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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. Add or update unit tests along with your patch. Run the unit tests in at least one browser (see below).
7+
3. Run `grunt` (see below) to check for linting and a few other issues.
8+
4. 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"
9+
10+
## Unit Tests
11+
12+
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 commiting. Usually latest Chrome, Firefox, Safari and Opera and a few IEs.
13+
14+
## Linting
15+
16+
To run jshint and other tools, use `grunt`. To install, you need nodejs and npm, then run `npm install -g grunt`.

0 commit comments

Comments
 (0)