Docs: Reduce contributing guidelines by linking to contribute.jquery.org #1161

Closed
wants to merge 7 commits into
from

Conversation

Projects
None yet
5 participants
@scottgonzalez
Member

scottgonzalez commented Jan 6, 2014

This is an initial attempt to reduce our contributing guidelines by offloading the majority of the documentation to our centralized contribution documentation, http://contribute.jquery.org. @jzaefferer and I spent some time this morning fleshing out http://contribute.jquery.org/code/ and the associated pages (currently only on stage). I'd like to do this for our larger projects, which all have pretty lengthy contributing guidelines.

@ajpiano

This comment has been minimized.

Show comment
Hide comment
@ajpiano

ajpiano Jan 6, 2014

Member

👍

Member

ajpiano commented Jan 6, 2014

👍

@jaspermdegroot

This comment has been minimized.

Show comment
Hide comment
@jaspermdegroot

jaspermdegroot Jan 6, 2014

Member

For info about the forums and IRC you can link to the support page on the project website.

Member

jaspermdegroot commented Jan 6, 2014

For info about the forums and IRC you can link to the support page on the project website.

CONTRIBUTING.md
## Discussion
### Forum and IRC
-The jQuery UI development team frequently tracks posts on the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui). If you have longer posts or questions please feel free to post them there. If you think you've found a bug please [file it in the bug tracker](#how-to-report-bugs).
+The jQuery UI development team frequently tracks posts on the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui). If you have longer posts or questions please feel free to post them there. If you think you've found a bug please [file it in the bug tracker](http://contribute.jquery.org/bug-reports/).
Additionally most of the jQuery UI development team can be found in the [#jqueryui-dev](http://webchat.freenode.net/?channels=jqueryui-dev) IRC channel on irc.freenode.net.

This comment has been minimized.

@tjvantoll

tjvantoll Jan 6, 2014

Member

This is now redundant as you mention #jqueryui-dev on line #7.

@tjvantoll

tjvantoll Jan 6, 2014

Member

This is now redundant as you mention #jqueryui-dev on line #7.

CONTRIBUTING.md
### Build a Local Copy of jQuery UI
-Create a fork of the jQuery UI repo on github at http://github.com/jquery/jquery-ui

This comment has been minimized.

@tjvantoll

tjvantoll Jan 6, 2014

Member

There should be a period added here too.

@tjvantoll

tjvantoll Jan 6, 2014

Member

There should be a period added here too.

CONTRIBUTING.md
### Build a Local Copy of jQuery UI
-Create a fork of the jQuery UI repo on github at http://github.com/jquery/jquery-ui
+Create a fork of the jQuery UI repo on GitHub at http://github.com/jquery/jquery-ui
Change directory to your web root directory, whatever that might be:

This comment has been minimized.

@tjvantoll

tjvantoll Jan 6, 2014

Member

Not related to your changes, but the first "directory" should be removed.

@tjvantoll

tjvantoll Jan 6, 2014

Member

Not related to your changes, but the first "directory" should be removed.

@tjvantoll

This comment has been minimized.

Show comment
Hide comment
@tjvantoll

tjvantoll Jan 6, 2014

Member

Other than my few trivial comments this looks good.

Member

tjvantoll commented Jan 6, 2014

Other than my few trivial comments this looks good.

@scottgonzalez

This comment has been minimized.

Show comment
Hide comment
@scottgonzalez

scottgonzalez Jan 8, 2014

Member

Updated based on feedback from @tjvantoll and @ugomobi.

Member

scottgonzalez commented Jan 8, 2014

Updated based on feedback from @tjvantoll and @ugomobi.

@tjvantoll

This comment has been minimized.

Show comment
Hide comment
@tjvantoll

tjvantoll Jan 8, 2014

Member

👍

Member

tjvantoll commented Jan 8, 2014

👍

+You may also want to take a look at our [commit & pull request guide](http://contribute.jquery.org/commits-and-pull-requests/) and [style guides](http://contribute.jquery.org/style-guide/) for instructions on how to maintain your fork and submit your code. Before we can merge any pull request, we'll also need you to sign our [contributor license agreement](http://contribute.jquery.org/cla).

This comment has been minimized.

@jzaefferer

jzaefferer Jan 8, 2014

Member

Let's put the CLA sentence first.

@jzaefferer

jzaefferer Jan 8, 2014

Member

Let's put the CLA sentence first.

This comment has been minimized.

@scottgonzalez

scottgonzalez Jan 8, 2014

Member

This is common boilerplate. If we update the order here, we'll need to update it in a few dozen repos.

@scottgonzalez

scottgonzalez Jan 8, 2014

Member

This is common boilerplate. If we update the order here, we'll need to update it in a few dozen repos.

CONTRIBUTING.md
-### Environment: localhost w/ PHP, Node & Grunt
-
-jQuery UI uses node & gruntjs to automate the building and validation of source code.
+jQuery UI uses Node.js & Grunt to automate the building and validation of source code.
Some tests depend on PHP running locally, so make sure you have the following installed:
* Some kind of localhost server program that supports PHP (any will do)

This comment has been minimized.

@jzaefferer

jzaefferer Jan 8, 2014

Member

We could suggest MAMP here, and link to it.

@jzaefferer

jzaefferer Jan 8, 2014

Member

We could suggest MAMP here, and link to it.

This comment has been minimized.

@scottgonzalez

scottgonzalez Jan 8, 2014

Member

That's only for one OS.

@scottgonzalez

scottgonzalez Jan 8, 2014

Member

That's only for one OS.

This comment has been minimized.

@jzaefferer

jzaefferer Jan 9, 2014

Member

We could link to MAMP and XAMPP, like this:

(any will do, e.g. [XAMPP](http://www.mamp.info/en/index.html) for Windows, [MAMP](http://www.mamp.info/en/index.html) for OSX)

I'm okay leaving it as-is as well.

@jzaefferer

jzaefferer Jan 9, 2014

Member

We could link to MAMP and XAMPP, like this:

(any will do, e.g. [XAMPP](http://www.mamp.info/en/index.html) for Windows, [MAMP](http://www.mamp.info/en/index.html) for OSX)

I'm okay leaving it as-is as well.

CONTRIBUTING.md
-* NPM (comes with the latest version of Node.js)
-* Grunt (install with: `npm install grunt -g`
-
+* Node.js and NPM (comes with the latest version of Node.js)

This comment has been minimized.

@jzaefferer

jzaefferer Jan 8, 2014

Member

How about this:

* [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
@jzaefferer

jzaefferer Jan 8, 2014

Member

How about this:

* [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
CONTRIBUTING.md
-* Grunt (install with: `npm install grunt -g`
-
+* Node.js and NPM (comes with the latest version of Node.js)
+* Grunt (install with: `npm install -g grunt`
Maintaining a list of platform specific instructions is outside of the scope of this document and there is plenty of existing documentation for the above technologies.

This comment has been minimized.

@jzaefferer

jzaefferer Jan 8, 2014

Member

Let's remove this. Links to both MAMP and node.js will do the job of providing "existing documentation".

@jzaefferer

jzaefferer Jan 8, 2014

Member

Let's remove this. Links to both MAMP and node.js will do the job of providing "existing documentation".

CONTRIBUTING.md
@@ -91,25 +40,25 @@ Change directory to your web root directory, whatever that might be:
$ cd /path/to/your/www/root/
```
-Clone your jQuery UI fork to work locally
+Clone your jQuery UI fork to work locally.
```bash
$ git clone git@github.com:username/jquery-ui.git

This comment has been minimized.

@jzaefferer

jzaefferer Jan 8, 2014

Member
$ git clone git@github.com:[USERNAME]/jquery-ui.git

to make it more obvious that this line as-is won't work and has to be edited

@jzaefferer

jzaefferer Jan 8, 2014

Member
$ git clone git@github.com:[USERNAME]/jquery-ui.git

to make it more obvious that this line as-is won't work and has to be edited

CONTRIBUTING.md
@@ -121,80 +70,9 @@ To lint the JavaScript, HTML, and CSS, as well as run a smoke test in PhantomJS,
$ grunt

This comment has been minimized.

@jzaefferer

jzaefferer Jan 8, 2014

Member

This is missing npm install, which also needs to run whenever there's dependency changes (not just once after clone).

@jzaefferer

jzaefferer Jan 8, 2014

Member

This is missing npm install, which also needs to run whenever there's dependency changes (not just once after clone).

CONTRIBUTING.md
+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.
### jQuery UI supports the following browsers:

This comment has been minimized.

@jzaefferer

jzaefferer Jan 8, 2014

Member

It seems odd to have this list here. We should have something like http://jquery.com/browser-support/ on jqueryui.com, and remove the list here.

@jzaefferer

jzaefferer Jan 8, 2014

Member

It seems odd to have this list here. We should have something like http://jquery.com/browser-support/ on jqueryui.com, and remove the list here.

This comment has been minimized.

@scottgonzalez

scottgonzalez Jan 8, 2014

Member

Ok, I'll put together a PR for jqueryui.com.

@scottgonzalez

scottgonzalez Jan 8, 2014

Member

Ok, I'll put together a PR for jqueryui.com.

This comment has been minimized.

@scottgonzalez

This comment has been minimized.

Show comment
Hide comment
@scottgonzalez

scottgonzalez Jan 8, 2014

Member

I believe all comments have been addressed. @jzaefferer Please do another round of review.

Member

scottgonzalez commented Jan 8, 2014

I believe all comments have been addressed. @jzaefferer Please do another round of review.

CONTRIBUTING.md
-* Grunt (install with: `npm install grunt -g`
-
+* [Node.js](http://nodejs.org/) (includes NPM, necessary for the next step)
+* Grunt (install with: `npm install -g grunt`
Maintaining a list of platform specific instructions is outside of the scope of this document and there is plenty of existing documentation for the above technologies.

This comment has been minimized.

@jzaefferer

jzaefferer Jan 9, 2014

Member

If we link to MAMP/XAMPP above, we can remove this line.

@jzaefferer

jzaefferer Jan 9, 2014

Member

If we link to MAMP/XAMPP above, we can remove this line.

@jzaefferer

This comment has been minimized.

Show comment
Hide comment
@jzaefferer

jzaefferer Jan 9, 2014

Member

Good to land, with or without the HTTP server links.

Member

jzaefferer commented Jan 9, 2014

Good to land, with or without the HTTP server links.

@scottgonzalez

This comment has been minimized.

Show comment
Hide comment
@scottgonzalez

scottgonzalez Jan 9, 2014

Member

Added links for XAMPP and MAMP in 08db028.

Member

scottgonzalez commented Jan 9, 2014

Added links for XAMPP and MAMP in 08db028.

@scottgonzalez scottgonzalez deleted the scottgonzalez:contributing branch Jul 2, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment