CONTRIBUTING.md

   1 # Contributing to jQuery
   2
   3 1. [Getting Involved](#getting-involved)
   4 2. [Questions and Discussion](#questions-and-discussion)
   5 3. [How To Report Bugs](#how-to-report-bugs)
   6 4. [Tips for Bug Patching](#tips-for-bug-patching)
   7
   8 Note: This is the code development repository for *jQuery Core* only. Before opening an issue or making a pull request, be sure you're in the right place.
   9 * jQuery plugin issues should be reported to the author of the plugin.
  10 * jQuery Core API documentation issues can be filed [at the API repo](http://github.com/jquery/api.jquery.com/issues).
  11 * Bugs or suggestions for other jQuery Foundation projects should be filed in [their respective repos](http://github.com/jquery/).
  12
  13 ## Getting Involved
  14
  15 We've put together [a short guide with tips, tricks, and ideas on getting started](http://contribute.jquery.org/open-source/). We're always looking for help identifying bugs, writing and reducing test cases, and documentation.
  16
  17 More information on how to contribute to this and other jQuery Foundation projects is at [contribute.jquery.org](http://contribute.jquery.org). Please review 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 a fork and submit patches. Before we can merge any pull request, we'll also need you to sign our [contributor license agreement](http://contribute.jquery.org/cla/).
  18
  19
  20 ## Questions and Discussion
  21
  22 ### Forum and IRC
  23
  24 jQuery is so popular that many developers have knowledge of its capabilities and limitations. Most questions about using jQuery can be answered on popular forums such as [Stack Overflow](http://stackoverflow.com). Please start there when you have questions, even if you think you've found a bug.
  25
  26 The jQuery Core team watches the [jQuery Development Forum](http://forum.jquery.com/developing-jquery-core). If you have longer posts or questions that can't be answered in places such as Stack Overflow, 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 Core team can be found in the [#jquery-dev](http://webchat.freenode.net/?channels=jquery-dev) IRC channel on irc.freenode.net.
  27
  28 ### Weekly Status Meetings
  29
  30 The jQuery Core team has a weekly meeting to discuss the progress of current work. 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 Mondays.
  31
  32 [jQuery Core Meeting Notes](http://meetings.jquery.org/category/core/)
  33
  34
  35 ## How to Report Bugs
  36
  37 ### Make sure it is a jQuery bug
  38
  39 Most bugs reported to our bug tracker are actually bugs in user code, not in jQuery code. Keep in mind that just because your code throws an error inside of jQuery, this does *not* mean the bug is a jQuery bug.
  40
  41 Ask for help first in the [Using jQuery Forum](http://forum.jquery.com/using-jquery) or another discussion forum like [Stack Overflow](http://stackoverflow.com/). You will get much quicker support, and you will help avoid tying up the jQuery team with invalid bug reports.
  42
  43 ### Disable browser extensions
  44
  45 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.
  46
  47 ### Try the latest version of jQuery
  48
  49 Bugs in old versions of jQuery may have already been fixed. In order to avoid reporting known issues, make sure you are always testing against the [latest build](http://code.jquery.com/jquery.js). We cannot fix bugs in older released files, if a bug has been fixed in a subsequent version of jQuery the site should upgrade.
  50
  51 ### Simplify the test case
  52
  53 When experiencing a problem, [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 reported without reduced test cases take on average 9001% longer to fix than bugs that are submitted with them, so you really should try to do this if at all possible.
  54
  55 ### Search for related or duplicate issues
  56
  57 Go to the [jQuery Core issue tracker](https://github.com/jquery/jquery/issues) and make sure the problem hasn't already been reported. If not, create a new issue there and include your test case.
  58
  59
  60 ## Tips For Bug Patching
  61
  62 We *love* when people contribute back to the project by patching the bugs they find. Since jQuery is used by so many people, we are cautious about the patches we accept and want to be sure they don't have a negative impact on the millions of people using jQuery each day. For that reason it can take a while for any suggested patch to work its way through the review and release process. The reward for you is knowing that the problem you fixed will improve things for millions of sites and billions of visits per day.
  63
  64 ### Build a Local Copy of jQuery
  65
  66 Create a fork of the jQuery repo on github at http://github.com/jquery/jquery
  67
  68 Change directory to your web root directory, whatever that might be:
  69
  70 ```bash
  71 $ cd /path/to/your/www/root/
  72 ```
  73
  74 Clone your jQuery fork to work locally
  75
  76 ```bash
  77 $ git clone git@github.com:username/jquery.git
  78 ```
  79
  80 Change directory to the newly created dir jquery/
  81
  82 ```bash
  83 $ cd jquery
  84 ```
  85
  86 Add the jQuery master as a remote. I label mine "upstream"
  87
  88 ```bash
  89 $ git remote add upstream git://github.com/jquery/jquery.git
  90 ```
  91
  92 Get in the habit of pulling in the "upstream" master to stay up to date as jQuery receives new commits
  93
  94 ```bash
  95 $ git pull upstream master
  96 ```
  97
  98 Run the build script
  99
 100 ```bash
 101 $ npm run build
 102 ```
 103
 104 Run the Grunt tools:
 105
 106 ```bash
 107 $ grunt && grunt watch
 108 ```
 109
 110 Now open the jQuery test suite in a browser at http://localhost/test. If there is a port, be sure to include it.
 111
 112 Success! You just built and tested jQuery!
 113
 114
 115 ### Test Suite Tips...
 116
 117 During the process of writing your patch, you will run the test suite MANY times. You can speed up the process by narrowing the running test suite down to the module you are testing by either double clicking the title of the test or appending it to the url. The following examples assume you're working on a local repo, hosted on your localhost server.
 118
 119 Example:
 120
 121 http://localhost/test/?filter=css
 122
 123 This will only run the "css" module tests. This will significantly speed up your development and debugging.
 124
 125 **ALWAYS RUN THE FULL SUITE BEFORE COMMITTING AND PUSHING A PATCH!**
 126
 127
 128 ### Browser support
 129
 130 Remember that jQuery supports multiple browsers and their versions; any contributed code must work in all of them. You can refer to the [browser support page](http://jquery.com/browser-support/) for the current list of supported browsers.
 131
 132 Note that browser support differs depending on whether you are targeting the `master` or `compat` branch.