Docs: Clarify PHP Usage #1418
Docs: Clarify PHP Usage #1418
Conversation
|
I forget if we ever actually required PHP for unit tests, but I believe you're correct that we don't require them for any tests now. I still feel pretty strongly that a first time contributor with a small patch (which is a decent portion of our contributors) shouldn't need to install node. Perhaps we should have both minimal requirements and recommended setups documented. Ideally you run |
|
I think that would make things clearer - I can change to that. re: the contributors section, I thought that was a bit unclear - there are loads of links and the ones in the readme (I didn't notice CONTRIBUTING at first) point to the wiki page - where some of the links e.g. Commit Message Style Guide go to invalid pages. Perhaps it is better someone experienced re-writes or looks at those paragraphs - but I could certainly do that with some guidance - otherwise I'll just clean up the testing requirements. |
lukeapage
force-pushed
the
running-tests
branch
from
c49b210 to
8c46438
Compare
|
Okay, I've shuffled things around a bit, I think it is a further improvement. |
Thanks for pointing that out, I'll go through and clean that up. We've done a lot of work to try to consolidate this information on the new contribute.jquery.org site. I guess there are still a few older pages that have links that haven't been updated to point to the new content. |
| * [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step) | ||
| * Grunt (install with: `npm install -g grunt`) | ||
| * Get [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step) | ||
| * Install Grunt cli (install with: `npm install -g grunt`) |
|
Overall, this looks good to me. I'd like to wait for some others to chime in though. |
lukeapage
force-pushed
the
running-tests
branch
from
a539bfa to
012c0e9
Compare
|
I've adjusted based on comments and also made a few further change - I understand this is a little controversial and that everyone will have their own opinion on the best wording, but I am sure this is better than it is currently, so will just see if anyone else has any feedback. |
|
|
||
| jQuery UI uses Node.js & Grunt to automate the building and validation of source code. | ||
| 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: |
There was a problem hiding this comment.
"clone jquery ui directly"
It's always either jquery-ui (the repo) or jQuery UI (the project).
|
Thanks for the updates. I left comments for a few small tweaks, but this looks great. |
|
|
||
| You can also run the unit tests inside phantomjs by [setting up your environment](CONTRIBUTING.md#user-content-environment-recommended-setup). | ||
|
|
||
| ## Building jQuery UI | ||
|
|
||
| jQuery UI uses the [Grunt](https://github.com/gruntjs/grunt) build system. |
There was a problem hiding this comment.
While we're making changes, we should probably update this to link to http://gruntjs.com/ instead.
Clarify that PHP is not required for testing, add a link to the CONTRIBUTING page and tidy up.
lukeapage
force-pushed
the
running-tests
branch
from
012c0e9 to
7a9eb94
Compare
|
tweaks done |
|
Thanks. |
Clarify that PHP is not required for testing and add a link to the CONTRIBUTING page.
I was a bit confused by the Readme and it seems to be out of date. Sorry if I am wrong about the tests not requiring PHP, but they seem to run without it and its alot less hassle to not need a PHP server.