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-26
Original file line number
Diff line number
Diff line change
@@ -16,68 +16,83 @@ This is the best way to contribute to jQuery UI. Please read through the full gu
16
16
17
17
Every week (unless otherwise noted) the jQuery UI team has a meeting to discuss the progress of current work and to bring forward possible new blockers for discussion. The meeting is held on [IRC](http://irc.jquery.org) in the #jquery-meeting channel at [Noon EST](http://www.timeanddate.com/worldclock/fixedtime.html?month=1&day=17&year=2011&hour=12&min=0&sec=0&p1=43) on Wednesdays. Meeting notes are posted on http://meetings.jquery.org/category/ui/ after each meeting.
jQuery UI uses Node.js & Grunt to automate the building and validation of source code.
23
+
If you are contributing changes you will need a fork of jquery-ui (see [Getting the Source](#environment-getting-the-source)). If you just want the source code you could clone jquery-ui directly:
24
24
25
-
Some tests depend on PHP running locally, so make sure you have the following installed:
26
-
27
-
* A web server with PHP support (any will do, such as [XAMPP](http://www.apachefriends.org/en/xampp.html) or [MAMP](http://www.mamp.info/en/index.html))
28
-
*[Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
29
-
* Grunt (install with: `npm install -g grunt`)
25
+
```bash
26
+
git clone git://github.com/jquery/jquery-ui.git
27
+
cd jquery-ui
28
+
```
30
29
31
-
### 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 the [Recommended Setup](#environment-recommended-setup) for setting up Node.js so that the grunt command works.
32
31
33
-
Create a fork of the jQuery UI repo on GitHub at http://github.com/jquery/jquery-ui.
32
+
### Environment: Getting the Source
34
33
35
-
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 in your Github account.
35
+
* You may want to clone jquery-ui under the path to your web server. If so, change to the required directory
36
36
37
37
```bash
38
-
$ cd /path/to/your/www/root/
38
+
cd /path/to/your/www/root/
39
39
```
40
40
41
-
Clone your jQuery UI fork to work locally.
42
-
43
-
*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:
74
91
75
92
```bash
76
-
$ grunt
93
+
grunt
77
94
```
78
95
79
96
To run the tests for a specific plugin in your browser, open the appropriate file from the `/tests/unit/` directory, for example: `http://localhost/tests/unit/accordion/accordion.html`. The domain will be dependent on your local server configuration; if there is a port, be sure to include it.
80
97
81
98
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.
82
-
83
-
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.
Copy file name to clipboardexpand all lines: README.md
+6-20
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ If you are interested in helping develop jQuery UI, you are in the right place.
10
10
To discuss development with team members and the community, visit the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui) or [#jqueryui-dev on irc.freenode.net](http://irc.jquery.org/).
11
11
12
12
13
-
## For contributors
13
+
## For Contributors
14
14
15
15
If you want to help and provide a patch for a bugfix or new feature, please take
16
16
a few minutes and look at [our Getting Involved guide](http://wiki.jqueryui.com/w/page/35263114/Getting-Involved).
@@ -21,35 +21,21 @@ In general, fork the project, create a branch for a specific change and send a
21
21
pull request for that branch. Don't mix unrelated changes. You can use the commit
22
22
message as the description for the pull request.
23
23
24
+
For more information, see the [contributing page](CONTRIBUTING.md).
24
25
25
26
## Running the Unit Tests
26
27
27
-
Run the unit tests with a local server that supports PHP. No database is required. Pre-configured php local servers are available for Windows and Mac. Here are some options:
Run the unit tests manually with appropriate browsers and any local web server. See our [environment setup](CONTRIBUTING.md#environment-minimum-required) and [information on running tests](CONTRIBUTING.md#running-the-tests).
33
29
30
+
You can also run the unit tests inside phantomjs by [setting up your environment](CONTRIBUTING.md#user-content-environment-recommended-setup).
34
31
35
32
## Building jQuery UI
36
33
37
-
jQuery UI uses the [Grunt](http://github.com/gruntjs/grunt) build system.
34
+
jQuery UI uses the [Grunt](http://gruntjs.com/) build system.
38
35
39
-
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#environment-minimum-required)) and then run the following commands:
0 commit comments