Skip to content

Commit 3cf4931

Browse files
committed
Docs: Commit will be squashed
1 parent 8c46438 commit 3cf4931

File tree

2 files changed

+44
-45
lines changed

2 files changed

+44
-45
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,61 +20,74 @@ Every week (unless otherwise noted) the jQuery UI team has a meeting to discuss
2020

2121
### Environment: minimum required
2222

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:
2424

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)
32-
* Install Grunt cli (install with: `npm install -g grunt`)
33-
* 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+
```
3529

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

38-
Create a fork of the jQuery UI repo on GitHub at http://github.com/jquery/jquery-ui.
32+
### Environment: Getting the source
3933

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
4136

4237
```bash
4338
$ cd /path/to/your/www/root/
4439
```
4540

46-
Clone your jQuery UI fork to work locally.
47-
48-
*Note: be sure to replace `[USERNAME]` with your GitHub username.*
41+
* Clone your jQuery UI git repo.
4942

5043
```bash
51-
$ git clone git@github.com:[USERNAME]/jquery-ui.git
44+
$ git clone git://github.com/[USERNAME]/jquery-ui.git
45+
$ cd jquery-ui
5246
```
5347

54-
Change to the newly created directory.
48+
*Note: be sure to replace `[USERNAME]` with your GitHub username.*
49+
50+
* Add the official jQuery repository as a remote. We recommend naming it "upstream".
5551

5652
```bash
57-
$ cd jquery-ui
53+
$ git remote add upstream git://github.com/jquery/jquery-ui.git
5854
```
5955

60-
Add the official jQuery repository as a remote. We recommend naming it "upstream".
56+
* Get in the habit of pulling in the "upstream" master to stay up to date as jQuery UI receives new commits.
6157

6258
```bash
63-
$ git remote add upstream git://github.com/jquery/jquery-ui.git
59+
$ git pull upstream master
6460
```
6561

66-
Get in the habit of pulling in the "upstream" master to stay up to date as jQuery UI receives new commits.
62+
### Environment: Recommended setup
63+
64+
jQuery UI uses Node.js & Grunt to automate the building and validation of source code. Here is how to set that up:
65+
66+
* Get [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
67+
* Install Grunt cli:
6768

6869
```bash
69-
$ git pull upstream master
70+
$ npm install -g grunt-cli
7071
```
7172

72-
Install the dependencies.
73+
* Install local Node.js modules
7374

7475
```bash
75-
npm install
76+
$ npm install
7677
```
7778

79+
The tests require a local web server and the samples contain some PHP, so a PHP web server may be useful.
80+
81+
* Install a web server. Here are some you could use:
82+
83+
- Windows: [WAMP download](http://www.wampserver.com/en/)
84+
- Mac: [MAMP download](http://www.mamp.info/en/index.html)
85+
- Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
86+
- [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
87+
- [http-server](https://www.npmjs.com/package/http-server)
88+
89+
### Running the tests
90+
7891
To lint the JavaScript, HTML, and CSS, as well as run a smoke test in PhantomJS, run grunt:
7992

8093
```bash
@@ -85,4 +98,6 @@ To run the tests for a specific plugin in your browser, open the appropriate fil
8598

8699
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.
87100

101+
### Before making a pull request
102+
88103
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.

README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,33 +25,17 @@ For more detailed information, see the [contributing page](CONTRIBUTING.md).
2525

2626
## Running the Unit Tests
2727

28-
Run the unit tests manually with appropriate browsers and any local web server. Here are a selection you could use.
29-
- Windows: [WAMP download](http://www.wampserver.com/en/)
30-
- Mac: [MAMP download](http://www.mamp.info/en/index.html)
31-
- Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
32-
- [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
33-
- [http-server](https://www.npmjs.com/package/http-server)
28+
Run the unit tests manually with appropriate browsers and any local web server. See our environment setup and information on running tests.
3429

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).
3631

3732
## Building jQuery UI
3833

3934
jQuery UI uses the [Grunt](http://github.com/gruntjs/grunt) build system.
4035

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:
4237

4338
```sh
44-
45-
# Install the Grunt CLI
46-
npm install -g grunt-cli
47-
48-
# Clone the jQuery UI git repo
49-
git clone git://github.com/jquery/jquery-ui.git
50-
cd jquery-ui
51-
52-
# Install the node module dependencies
53-
npm install
54-
5539
# Run the concat task to concatenate files
5640
grunt concat
5741

0 commit comments

Comments
 (0)