diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb517be..1ec9357 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,6 +15,15 @@ Thanks for contributing! Here's a few guidelines to help your contribution get l 3. Install the NPM dependencies by running `npm install`. 4. The build can now be called by running `grunt`. +## Creating a new Additional Method + +If you've wrote custom methods that you'd like to contribute to additional-methods.js: + +1. Create a branch +2. Add the method as a new file in src/additional +3. (Optional) Add translations to src/localization +4. Send a pull request to the master branch. + ## Unit Tests 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. diff --git a/README.md b/README.md index e1ccc3e..0be7fbb 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,20 @@ You can find the plan for how to spend the money on the [pledgie page](http://pl ## Getting Started +### Downloading the prebuilt files + +Prebuilt files can be downloaded from http://jqueryvalidation.org/ + +### Downloading the latest changes + +The unreleased development files can be obtained by: + + 1. [Downloading](https://github.com/jzaefferer/jquery-validation/archive/master.zip) or Forking this repository + 2. [Setup the build](CONTRIBUTING.md#build-setup) + 3. Run `grunt` to create the built files in the "dist" directory + +### Including it on your page + Include jQuery and the plugin on a page. Then select a form to validate and call the `validate` method. ```html @@ -39,17 +53,8 @@ For more information on how to setup a rules and customizations, [check the docu 4. What version of the plug-in is the issue reproducible in. Is it reproducible after updating to the latest version. ## Contributing -1. Follow the [jQuery style guide](http://contribute.jquery.com/style-guides/js), even if existing code doesn't. -2. Add unit tests for any new or changed functionality. -3. Lint and test your code using [Grunt](http://gruntjs.com/). -### Additional Methods -If you've wrote custom methods that you'd like to contribute to additional-methods.js: - -1. Create a branch -2. Add the method as a new file in src/additional -3. (Optional) Add translations to src/localization -4. Send a pull request to the master branch. +See the [Contributing Guide](CONTRIBUTING.md) ## License Copyright (c) 2013 Jörn Zaefferer