You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+41-26Lines changed: 41 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -20,61 +20,74 @@ Every week (unless otherwise noted) the jQuery UI team has a meeting to discuss
20
20
21
21
### Environment: minimum required
22
22
23
-
The tests can run in any local web server. Ideally you should test your patch in appropriate web browsers and if possible run `grunt` to lint the code and run automated tests (this will happen automatically when you create a pull request).
23
+
If you are contributing you will need a fork of jquery (see Getting the source). If you just want the source code you could clone jquery ui directly:
24
24
25
-
### Environment: Recommended setup
26
-
27
-
jQuery UI uses Node.js & Grunt to automate the building and validation of source code.
28
-
29
-
The tests require a local web server and the samples contain some PHP, so a PHP web server may be useful.
30
-
31
-
* Get [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
* Install local modules (`npm install` in the root directory)
34
-
* Install a web server (PHP support optional - such as [XAMPP](http://www.apachefriends.org/en/xampp.html) or [MAMP](http://www.mamp.info/en/index.html) or for node you can use [http-server](https://www.npmjs.com/package/http-server))
25
+
```bash
26
+
$ git clone git://github.com/jquery/jquery-ui.git
27
+
$ cd jquery-ui
28
+
```
35
29
36
-
### Build a Local Copy of jQuery UI
30
+
The tests can run in any local web server. Ideally you should test your patch in appropriate web browsers and if possible run `grunt` to lint the code and run automated tests (this will happen automatically when you create a pull request). See below for setting up Node.js so that the grunt command works.
37
31
38
-
Create a fork of the jQuery UI repo on GitHub at http://github.com/jquery/jquery-ui.
32
+
### Environment: Getting the source
39
33
40
-
Change directory to your web root directory, whatever that might be:
34
+
* Create a fork of the jQuery UI repo on GitHub at http://github.com/jquery/jquery-ui. This will create a fork of jquery-ui at your username.
35
+
* You may want to clone jquery-ui under the path to your web server. If so, change to the required directory
41
36
42
37
```bash
43
38
$ cd /path/to/your/www/root/
44
39
```
45
40
46
-
Clone your jQuery UI fork to work locally.
47
-
48
-
*Note: be sure to replace `[USERNAME]` with your GitHub username.*
To lint the JavaScript, HTML, and CSS, as well as run a smoke test in PhantomJS, run grunt:
79
92
80
93
```bash
@@ -85,4 +98,6 @@ To run the tests for a specific plugin in your browser, open the appropriate fil
85
98
86
99
Ideally you would test in all of our [supported browsers](http://jqueryui.com/browser-support/), but if you don't have all of these browsers available, that's ok.
87
100
101
+
### Before making a pull request
102
+
88
103
Make sure to read our [commits and pull requests documentation](http://dev.contribute.jquery.org/commits-and-pull-requests/) for full details on working with branches and forks, as well as our commit guidelines.
Run the unit tests manually with appropriate browsers and any local web server. See our environment setup and information on running tests.
34
29
35
-
You can also run the unit tests inside phantomjs by [installing node](http://nodejs.org/) and the required modules(`npm install`) and then running `grunt test`.
30
+
You can also run the unit tests inside phantomjs by [setting up your environment](CONTRIBUTING.md#user-content-environment-recommended-setup).
36
31
37
32
## Building jQuery UI
38
33
39
34
jQuery UI uses the [Grunt](http://github.com/gruntjs/grunt) build system.
40
35
41
-
To build jQuery UI, you must have [node.js](http://nodejs.org/) installed and then run the following commands:
36
+
To build jQuery UI, [setup your environment]([setting up your environment](CONTRIBUTING.md#user-content-environment-recommended-setup)) and then run the following commands:
0 commit comments