Docs: Reduce contributing guidelines by linking to contribute.jquery.org #1161
Conversation
|
👍 |
|
For info about the forums and IRC you can link to the support page on the project website. |
|
|
||
| ## 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. |
There was a problem hiding this comment.
This is now redundant as you mention #jqueryui-dev on line #7.
|
Other than my few trivial comments this looks good. |
|
Updated based on feedback from @tjvantoll and @uGoMobi. |
|
👍 |
|
|
||
| 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). |
There was a problem hiding this comment.
Let's put the CLA sentence first.
There was a problem hiding this comment.
This is common boilerplate. If we update the order here, we'll need to update it in a few dozen repos.
| @@ -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 | |||
There was a problem hiding this comment.
$ 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
|
I believe all comments have been addressed. @jzaefferer Please do another round of review. |
| * 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. |
There was a problem hiding this comment.
If we link to MAMP/XAMPP above, we can remove this line.
|
Good to land, with or without the HTTP server links. |
|
Added links for XAMPP and MAMP in 08db028. |
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.