|
1 | 1 | # Contributing to jQuery UI |
2 | 2 |
|
3 | | -1. [Getting Involved](#getting-involved) |
4 | | -2. [Discussion](#discussion) |
5 | | -3. [How To Report Bugs](#how-to-report-bugs) |
6 | | -4. [jQuery UI Coding Standards](#jquery-ui-coding-standards) |
7 | | -5. [Tips For Bug Patching](#tips-for-bug-patching) |
| 3 | +Welcome! Thanks for your interest in contributing to jQuery UI. Most of our information on how to contribute to this and all other jQuery Foundation projects is over at [contribute.jquery.org](http://contribute.jquery.org). You'll definitely want to take a look at the articles on contributing [code](http://contribute.jquery.org/code). |
8 | 4 |
|
| 5 | +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). |
9 | 6 |
|
| 7 | +You can find us on [IRC](http://irc.jquery.org), specifically in #jqueryui-dev should you have any questions. If you've never contributed to open source before, we've put together [a short guide with tips, tricks, and ideas on getting started](http://contribute.jquery.org/open-source/). For other forms of discussion and support, please see the [jQuery UI support center](http://jqueryui.com/support/). |
10 | 8 |
|
11 | 9 | ## Getting Involved |
12 | 10 |
|
13 | 11 | There are a number of ways to get involved with the development of jQuery UI. Even if you've never contributed code to an Open Source project before, we're always looking for help identifying bugs, writing and reducing test cases and documentation. |
14 | 12 |
|
15 | | -This is the best way to contribute to jQuery UI. Please read through the full guide detailing [How to Report Bugs](#how-to-report-bugs). |
| 13 | +This is the best way to contribute to jQuery UI. Please read through the full guide detailing [How to Report Bugs](http://contribute.jquery.org/bug-reports/). |
16 | 14 |
|
17 | | -## Discussion |
| 15 | +### Weekly Meetings |
18 | 16 |
|
19 | | -### Forum and IRC |
20 | | - |
21 | | -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). |
22 | | - |
23 | | -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. |
24 | | - |
25 | | -### Weekly Status Meetings |
26 | | - |
27 | | -Every week (unless otherwise noted) the jQuery UI dev team has a meeting to discuss the progress of current work and to bring forward possible new blocker bugs for discussion. |
28 | | - |
29 | | -The meeting is held in the [#jquery-meeting](http://webchat.freenode.net/?channels=jquery-meeting) IRC channel on irc.freenode.net at [Noon EST](http://www.timeanddate.com/worldclock/fixedtime.html?month=1&day=17&year=2011&hour=12&min=0&sec=0&p1=43) on Wednesdays. |
30 | | - |
31 | | -Past Meeting Notes: |
32 | | -[2008 - 2011](https://docs.google.com/spreadsheet/ccc?key=0AusvKVL7jmFUcHVBQk9tMUxkRGl0emVwZGdLd0QtUlE), |
33 | | -[2012 - current](https://docs.google.com/spreadsheet/ccc?key=0ArIM4UVbwE-3dFg1T0k4VlE1bF82Nm9tbW90cVNxN0E) |
34 | | - |
35 | | - |
36 | | -## How to Report Bugs |
37 | | - |
38 | | -### Make sure it is a jQuery UI bug |
39 | | - |
40 | | -Many bugs reported to our bug tracker are actually bugs in user code, not in jQuery UI code. Keep in mind that just because your code throws an error and the console points to a line number inside of jQuery or jQuery UI, this does *not* mean the bug is a jQuery UI bug. |
41 | | - |
42 | | -If you are new to jQuery and/or jQuery UI, it is usually a much better idea to ask for help first in the [Using jQuery Forum](http://forum.jquery.com/using-jquery), the [Using jQuery UI Forum](http://forum.jquery.com/using-jquery-ui) or the [jQuery IRC channel](http://webchat.freenode.net/?channels=%23jquery). You will get much quicker support, and you will help avoid tying up the jQuery UI team with invalid bug reports. These same resources can also be useful if you want to confirm that your bug is indeed a bug in jQuery UI before filing any tickets. |
43 | | - |
44 | | - |
45 | | -### Disable any browser extensions |
46 | | - |
47 | | -Make sure you have reproduced the bug with all browser extensions and add-ons disabled, as these can sometimes cause things to break in interesting and unpredictable ways. Try using incognito, stealth or anonymous browsing modes. |
48 | | - |
49 | | - |
50 | | -### Try the latest version of jQuery UI |
51 | | - |
52 | | -Bugs in old versions of jQuery UI may have already been fixed. In order to avoid reporting known issues, make sure you are always testing against the latest stable release. |
53 | | - |
54 | | -### Try an older version of jQuery UI |
55 | | - |
56 | | -Sometimes, bugs are introduced in newer versions of jQuery UI that do not exist in previous versions. When possible, it can be useful to try testing with an older release. |
57 | | - |
58 | | -### Reduce, reduce, reduce! |
59 | | - |
60 | | -When you are experiencing a problem, the most useful thing you can possibly do is to [reduce your code](http://webkit.org/quality/reduction.html) to the bare minimum required to reproduce the issue. This makes it *much* easier to isolate and fix the offending code. Bugs that are reported without reduced test cases generally take much longer to fix than bugs that are submitted with them, so you really should try to do this if at all possible. |
61 | | - |
62 | | -## jQuery UI Coding Standards |
63 | | - |
64 | | -See: [jQuery UI Coding Standards](http://wiki.jqueryui.com/w/page/12137737/Coding%20standards) |
| 17 | +Every week (unless otherwise noted) the jQuery UI team has a meeting to discuss the progress of current work and to bring forward possible new blockers for discussion. The meeting is held on [IRC](http://irc.jquery.org) in the #jquery-meeting channel at [Noon EST](http://www.timeanddate.com/worldclock/fixedtime.html?month=1&day=17&year=2011&hour=12&min=0&sec=0&p1=43) on Wednesdays. Meeting notes are posted on http://meetings.jquery.org/category/ui/ after each meeting. |
65 | 18 |
|
66 | 19 | ## Tips For Bug Patching |
67 | 20 |
|
| 21 | +### Environment: localhost w/ PHP, Node.js & Grunt |
68 | 22 |
|
69 | | -### Environment: localhost w/ PHP, Node & Grunt |
70 | | - |
71 | | -jQuery UI uses node & gruntjs to automate the building and validation of source code. |
| 23 | +jQuery UI uses Node.js & Grunt to automate the building and validation of source code. |
72 | 24 |
|
73 | 25 | Some tests depend on PHP running locally, so make sure you have the following installed: |
74 | 26 |
|
75 | | -* Some kind of localhost server program that supports PHP (any will do) |
76 | | -* Node.js |
77 | | -* NPM (comes with the latest version of Node.js) |
78 | | -* Grunt (install with: `npm install grunt -g` |
79 | | - |
80 | | - |
81 | | -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. |
82 | | - |
| 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` |
83 | 30 |
|
84 | 31 | ### Build a Local Copy of jQuery UI |
85 | 32 |
|
86 | | -Create a fork of the jQuery UI repo on github at http://github.com/jquery/jquery-ui |
| 33 | +Create a fork of the jQuery UI repo on GitHub at http://github.com/jquery/jquery-ui. |
87 | 34 |
|
88 | 35 | Change directory to your web root directory, whatever that might be: |
89 | 36 |
|
90 | 37 | ```bash |
91 | 38 | $ cd /path/to/your/www/root/ |
92 | 39 | ``` |
93 | 40 |
|
94 | | -Clone your jQuery UI fork to work locally |
| 41 | +Clone your jQuery UI fork to work locally. |
| 42 | + |
| 43 | +*Note: be sure to replace `[USERNAME]` with your GitHub username.* |
95 | 44 |
|
96 | 45 | ```bash |
97 | | -$ git clone git@github.com:username/jquery-ui.git |
| 46 | +$ git clone git@github.com:[USERNAME]/jquery-ui.git |
98 | 47 | ``` |
99 | 48 |
|
100 | | -Change directory to the newly created dir jquery-ui/ |
| 49 | +Change to the newly created directory. |
101 | 50 |
|
102 | 51 | ```bash |
103 | 52 | $ cd jquery-ui |
104 | 53 | ``` |
105 | 54 |
|
106 | | -Add the jQuery master as a remote. I label mine "upstream" |
| 55 | +Add the official jQuery repository as a remote. We recommend naming it "upstream". |
107 | 56 |
|
108 | 57 | ```bash |
109 | 58 | $ git remote add upstream git://github.com/jquery/jquery-ui.git |
110 | 59 | ``` |
111 | 60 |
|
112 | | -Get in the habit of pulling in the "upstream" master to stay up to date as jQuery UI receives new commits |
| 61 | +Get in the habit of pulling in the "upstream" master to stay up to date as jQuery UI receives new commits. |
113 | 62 |
|
114 | 63 | ```bash |
115 | 64 | $ git pull upstream master |
116 | 65 | ``` |
117 | 66 |
|
118 | | -To lint the JavaScript, HTML, and CSS, as well as run a smoke test in PhantomJS, run grunt: |
| 67 | +Install the dependencies. |
119 | 68 |
|
120 | 69 | ```bash |
121 | | -$ grunt |
| 70 | +npm install |
122 | 71 | ``` |
123 | 72 |
|
124 | | -To run the tests for a specific plugin in your browser, open the approriate file from the /tests/unit/ directory, for example: http://localhost/tests/unit/accordion/accordion.html. The domain will be dependent on your local server configuation; if there is a port, be sure to include it. |
125 | | - |
126 | | -Success! You just tested jQuery UI! |
127 | | - |
128 | | - |
129 | | -### Fix a bug from a ticket filed at bugs.jqueryui.com: |
130 | | - |
131 | | -**NEVER write your patches to the master branch** - it gets messy (I say this from experience!) |
132 | | - |
133 | | -**ALWAYS USE A "TOPIC" BRANCH!** Like so (#### = the ticket #)... |
134 | | - |
135 | | -Make sure you start with your up-to-date master: |
136 | | - |
137 | | -```bash |
138 | | -$ git checkout master |
139 | | -``` |
140 | | - |
141 | | -Create and checkout a new branch that includes the ticket # |
142 | | - |
143 | | -```bash |
144 | | -$ git checkout -b bug_#### |
145 | | - |
146 | | -# ( Explanation: this useful command will: |
147 | | -# "checkout" a "-b" (branch) by the name of "bug_####" |
148 | | -# or create it if it doesn't exist ) |
149 | | -``` |
150 | | - |
151 | | -Now you're on branch: bug_#### |
152 | | - |
153 | | -Determine the file you'll be working in... |
154 | | - |
155 | | -Open up the corresponding /tests/unit/?????.js and add the initial failing unit tests. This may seem awkward at first, but in the long run it will make sense. To truly and efficiently patch a bug, you need to be working against that bug. |
156 | | - |
157 | | -Next, open the source files and make your changes |
158 | | - |
159 | | -Run http://localhost/tests/unit/???? --> **ALL TESTS MUST PASS** |
160 | | - |
161 | | -Once you're satisfied with your patch... |
162 | | - |
163 | | -Stage the files to be tracked: |
164 | | - |
165 | | -```bash |
166 | | -$ git add filename |
167 | | -# (you can use "git status" to list the files you've changed) |
168 | | -``` |
169 | | - |
170 | | - |
171 | | -( I recommend NEVER, EVER using "git add . " ) |
172 | | - |
173 | | -Once you've staged all of your changed files, go ahead and commit them |
174 | | - |
175 | | -```bash |
176 | | -$ git commit -m "Component: Brief description of fix. Fixes #0000 - Ticket description." |
177 | | -``` |
178 | | - |
179 | | -See the [commit message style guide](http://wiki.jqueryui.com/w/page/25941597/Commit%20Message%20Style%20Guide) for more details on how to format your commit message. |
180 | | - |
181 | | -For a multiple line commit message, leave off the `-m "description"`. |
182 | | - |
183 | | -You will then be led into vi (or the text editor that you have set up) to complete your commit message. |
184 | | - |
185 | | -Then, push your branch with the bug fix commits to your github fork |
186 | | - |
187 | | -```bash |
188 | | -$ git push origin -u bug_#### |
189 | | -``` |
190 | | - |
191 | | -Before you tackle your next bug patch, return to the master: |
| 73 | +To lint the JavaScript, HTML, and CSS, as well as run a smoke test in PhantomJS, run grunt: |
192 | 74 |
|
193 | 75 | ```bash |
194 | | -$ git checkout master |
| 76 | +$ grunt |
195 | 77 | ``` |
196 | 78 |
|
| 79 | +To run the tests for a specific plugin in your browser, open the approriate file from the `/tests/unit/` directory, for example: `http://localhost/tests/unit/accordion/accordion.html`. The domain will be dependent on your local server configuation; if there is a port, be sure to include it. |
197 | 80 |
|
| 81 | +Ideally you would test in all of our [supported browsers](http://jqueryui.com/browser-support/), but if you don't have all of these browsers available, that's ok. |
198 | 82 |
|
199 | | -### jQuery UI supports the following browsers: |
200 | | - |
201 | | -* Chrome Current-1 |
202 | | -* Safari Current-1 |
203 | | -* Firefox Current-1 |
204 | | -* Opera Current-1 |
205 | | -* IE 7+ |
| 83 | +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. |
0 commit comments