Skip to content

Commit 9a30294

Browse files
committed
Docs: Squash me too
1 parent 3cf4931 commit 9a30294

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

CONTRIBUTING.md

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

2121
### Environment: minimum required
2222

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:
23+
If you are contributing changes you will need a fork of jquery (see [Getting the source](environment-getting-the-source)). If you just want the source code you could clone jquery ui directly:
2424

2525
```bash
26-
$ git clone git://github.com/jquery/jquery-ui.git
27-
$ cd jquery-ui
26+
git clone git://github.com/jquery/jquery-ui.git
27+
cd jquery-ui
2828
```
2929

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.
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 [full setup](environment-recommended-setup) for setting up Node.js so that the grunt command works.
3131

3232
### Environment: Getting the source
3333

3434
* 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.
3535
* You may want to clone jquery-ui under the path to your web server. If so, change to the required directory
3636

3737
```bash
38-
$ cd /path/to/your/www/root/
38+
cd /path/to/your/www/root/
3939
```
4040

4141
* Clone your jQuery UI git repo.
4242

4343
```bash
44-
$ git clone git://github.com/[USERNAME]/jquery-ui.git
45-
$ cd jquery-ui
44+
git clone git://github.com/[USERNAME]/jquery-ui.git
45+
cd jquery-ui
4646
```
4747

4848
*Note: be sure to replace `[USERNAME]` with your GitHub username.*
4949

5050
* Add the official jQuery repository as a remote. We recommend naming it "upstream".
5151

5252
```bash
53-
$ git remote add upstream git://github.com/jquery/jquery-ui.git
53+
git remote add upstream git://github.com/jquery/jquery-ui.git
5454
```
5555

5656
* Get in the habit of pulling in the "upstream" master to stay up to date as jQuery UI receives new commits.
5757

5858
```bash
59-
$ git pull upstream master
59+
git pull upstream master
6060
```
6161

6262
### Environment: Recommended setup
@@ -67,31 +67,31 @@ jQuery UI uses Node.js & Grunt to automate the building and validation of source
6767
* Install Grunt cli:
6868

6969
```bash
70-
$ npm install -g grunt-cli
70+
npm install -g grunt-cli
7171
```
7272

7373
* Install local Node.js modules
7474

7575
```bash
76-
$ npm install
76+
npm install
7777
```
7878

7979
The tests require a local web server and the samples contain some PHP, so a PHP web server may be useful.
8080

8181
* Install a web server. Here are some you could use:
8282

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)
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)
8888

8989
### Running the tests
9090

9191
To lint the JavaScript, HTML, and CSS, as well as run a smoke test in PhantomJS, run grunt:
9292

9393
```bash
94-
$ grunt
94+
grunt
9595
```
9696

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

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ In general, fork the project, create a branch for a specific change and send a
2121
pull request for that branch. Don't mix unrelated changes. You can use the commit
2222
message as the description for the pull request.
2323

24-
For more detailed information, see the [contributing page](CONTRIBUTING.md).
24+
For more 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. See our environment setup and information on running tests.
28+
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).
2929

3030
You can also run the unit tests inside phantomjs by [setting up your environment](CONTRIBUTING.md#user-content-environment-recommended-setup).
3131

3232
## Building jQuery UI
3333

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

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:
36+
To build jQuery UI, [setup your environment]([setting up your environment](CONTRIBUTING.md#environment-minimum-required)) and then run the following commands:
3737

3838
```sh
3939
# Run the concat task to concatenate files

0 commit comments

Comments
 (0)