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](https://github.com/jquery/api.jquery.com/issues).
  11 * Bugs or suggestions for other jQuery organization projects should be filed in [their respective repos](https://github.com/jquery/).
  12
  13 ## Getting Involved
  14
  15 [API design principles](https://github.com/jquery/jquery/wiki/API-design-guidelines)
  16
  17 We're always looking for help [identifying bugs](#how-to-report-bugs), writing and reducing test cases, and improving documentation. And although new features are rare, anything passing our [guidelines](https://github.com/jquery/jquery/wiki/Adding-new-features) will be considered.
  18
  19 More information on how to contribute to this and other jQuery organization projects is at [contribute.jquery.org](https://contribute.jquery.org), including a short guide with tips, tricks, and ideas on [getting started with open source](https://contribute.jquery.org/open-source/). Please review our [commit & pull request guide](https://contribute.jquery.org/commits-and-pull-requests/) and [style guides](https://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](https://contribute.jquery.org/cla/).
  20
  21
  22 ## Questions and Discussion
  23
  24 ### Forum and IRC
  25
  26 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](https://stackoverflow.com). Please start there when you have questions, even if you think you've found a bug.
  27
  28 The jQuery Core team watches the [jQuery Development Forum](https://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](https://webchat.freenode.net/?channels=jquery-dev) IRC channel on irc.freenode.net.
  29
  30 ### Weekly Status Meetings
  31
  32 The jQuery Core team has a weekly meeting to discuss the progress of current work. The meeting is held in the [#jquery-meeting](https://webchat.freenode.net/?channels=jquery-meeting) IRC channel on irc.freenode.net at [Noon EST](https://www.timeanddate.com/worldclock/fixedtime.html?month=1&day=17&year=2011&hour=12&min=0&sec=0&p1=43) on Mondays.
  33
  34 [jQuery Core Meeting Notes](https://meetings.jquery.org/category/core/)
  35
  36
  37 ## How to Report Bugs
  38
  39 ### Make sure it is a jQuery bug
  40
  41 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.
  42
  43 Ask for help first in the [Using jQuery Forum](https://forum.jquery.com/using-jquery) or another discussion forum like [Stack Overflow](https://stackoverflow.com/). You will get much quicker support, and you will help avoid tying up the jQuery team with invalid bug reports.
  44
  45 ### Disable 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 ### Try the latest version of jQuery
  50
  51 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](https://releases.jquery.com/git/jquery-git.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.
  52
  53 ### Simplify the test case
  54
  55 When experiencing a problem, [reduce your code](https://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.
  56
  57 ### Search for related or duplicate issues
  58
  59 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.
  60
  61
  62 ## Tips For Bug Patching
  63
  64 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.
  65
  66 ### Build a Local Copy of jQuery
  67
  68 Create a fork of the jQuery repo on github at https://github.com/jquery/jquery
  69
  70 Change directory to your web root directory, whatever that might be:
  71
  72 ```bash
  73 $ cd /path/to/your/www/root/
  74 ```
  75
  76 Clone your jQuery fork to work locally
  77
  78 ```bash
  79 $ git clone git@github.com:username/jquery.git
  80 ```
  81
  82 Change directory to the newly created dir jquery/
  83
  84 ```bash
  85 $ cd jquery
  86 ```
  87
  88 Add the jQuery main as a remote. I label mine "upstream"
  89
  90 ```bash
  91 $ git remote add upstream git://github.com/jquery/jquery.git
  92 ```
  93
  94 Get in the habit of pulling in the "upstream" main to stay up to date as jQuery receives new commits
  95
  96 ```bash
  97 $ git pull upstream main
  98 ```
  99
 100 Run the build script
 101
 102 ```bash
 103 $ npm run build
 104 ```
 105
 106 Now open the jQuery test suite in a browser at http://localhost/test. If there is a port, be sure to include it.
 107
 108 Success! You just built and tested jQuery!
 109
 110
 111 ### Test Suite Tips...
 112
 113 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.
 114
 115 Example:
 116
 117 http://localhost/test/?module=css
 118
 119 This will only run the "css" module tests. This will significantly speed up your development and debugging.
 120
 121 **ALWAYS RUN THE FULL SUITE BEFORE COMMITTING AND PUSHING A PATCH!**
 122
 123
 124 #### Loading changes on the test page
 125
 126 Rather than rebuilding jQuery with `grunt` every time you make a change, you can use the included `grunt watch` task to rebuild distribution files whenever a file is saved.
 127
 128 ```bash
 129 $ grunt watch
 130 ```
 131
 132 Alternatively, you can **load tests as ECMAScript modules** to avoid the need for rebuilding altogether.
 133
 134 Click "Load as modules" after loading the test page.
 135
 136
 137 ### Repo organization
 138
 139 The jQuery source is organized with ECMAScript modules and then compiled into one file at build time.
 140
 141 jQuery also contains some special modules we call "var modules", which are placed in folders named "var". At build time, these small modules are compiled to simple var statements. This makes it easy for us to share variables across modules. Browse the "src" folder for examples.
 142
 143 ### Browser support
 144
 145 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](https://jquery.com/browser-support/) for the current list of supported browsers.