Skip to content

Commit 3f84e23

Browse files
committed
Add Instructions for getting the dist files
Moved remaining contributing instructions to Contributing guide
1 parent b358fa8 commit 3f84e23

File tree

2 files changed

+24
-10
lines changed

2 files changed

+24
-10
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ Thanks for contributing! Here's a few guidelines to help your contribution get l
1515
3. Install the NPM dependencies by running `npm install`.
1616
4. The build can now be called by running `grunt`.
1717

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+
1827
## Unit Tests
1928

2029
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.

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@ You can find the plan for how to spend the money on the [pledgie page](http://pl
1616

1717
## Getting Started
1818

19+
### Downloading the prebuilt files
20+
21+
Prebuilt files can be downloaded from http://jqueryvalidation.org/
22+
23+
### Downloading the latest changes
24+
25+
The unreleased development files can be obtained by:
26+
27+
1. [Downloading](https://github.com/jzaefferer/jquery-validation/archive/master.zip) or Forking this repository
28+
2. [Setup the build](CONTRIBUTING.md#build-setup)
29+
3. Run `grunt` to create the built files in the "dist" directory
30+
31+
### Including it on your page
32+
1933
Include jQuery and the plugin on a page. Then select a form to validate and call the `validate` method.
2034

2135
```html
@@ -39,17 +53,8 @@ For more information on how to setup a rules and customizations, [check the docu
3953
4. What version of the plug-in is the issue reproducible in. Is it reproducible after updating to the latest version.
4054

4155
## Contributing
42-
1. Follow the [jQuery style guide](http://contribute.jquery.com/style-guides/js), even if existing code doesn't.
43-
2. Add unit tests for any new or changed functionality.
44-
3. Lint and test your code using [Grunt](http://gruntjs.com/).
45-
46-
### Additional Methods
47-
If you've wrote custom methods that you'd like to contribute to additional-methods.js:
4856

49-
1. Create a branch
50-
2. Add the method as a new file in src/additional
51-
3. (Optional) Add translations to src/localization
52-
4. Send a pull request to the master branch.
57+
See the [Contributing Guide](CONTRIBUTING.md)
5358

5459
## License
5560
Copyright (c) 2013 Jörn Zaefferer

0 commit comments

Comments
 (0)