Skip to content

Commit 8c46438

Browse files
committed
Docs: Clarify PHP Usage
Clarify that PHP is not required for testing and add a link to the CONTRIBUTING page.
1 parent faefab8 commit 8c46438

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

CONTRIBUTING.md

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

1919
## Tips For Bug Patching
2020

21-
### Environment: localhost w/ PHP, Node.js & Grunt
21+
### Environment: minimum required
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).
24+
25+
### Environment: Recommended setup
2226

2327
jQuery UI uses Node.js & Grunt to automate the building and validation of source code.
2428

25-
Some tests depend on PHP running locally, so make sure you have the following installed:
29+
The tests require a local web server and the samples contain some PHP, so a PHP web server may be useful.
2630

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`)
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))
3035

3136
### Build a Local Copy of jQuery UI
3237

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,18 @@ 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).
2425

2526
## Running the Unit Tests
2627

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:
28-
28+
Run the unit tests manually with appropriate browsers and any local web server. Here are a selection you could use.
2929
- Windows: [WAMP download](http://www.wampserver.com/en/)
3030
- Mac: [MAMP download](http://www.mamp.info/en/index.html)
3131
- Linux: [Setting up LAMP](https://www.linux.com/learn/tutorials/288158-easy-lamp-server-installation)
3232
- [Mongoose (most platforms)](http://code.google.com/p/mongoose/)
33+
- [http-server](https://www.npmjs.com/package/http-server)
3334

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`.
3436

3537
## Building jQuery UI
3638

0 commit comments

Comments
 (0)