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.
  20
  21 When opening a pull request, you'll be asked to sign our Contributor License Agreement. Both the Corporate and Individual agreements can be [previewed on GitHub](https://github.com/openjs-foundation/easycla).
  22
  23 If you're looking for some good issues to start with, [here are some issues labeled "help wanted" or "patch welcome"](https://github.com/jquery/jquery/issues?q=is%3Aissue+label%3A%22help+wanted%22%2C%22Patch+Welcome%22).
  24
  25 ## Questions and Discussion
  26
  27 ### Forum and IRC
  28
  29 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.
  30
  31 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.
  32
  33 ### Weekly Status Meetings
  34
  35 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.
  36
  37 [jQuery Core Meeting Notes](https://meetings.jquery.org/category/core/)
  38
  39
  40 ## How to Report Bugs
  41
  42 ### Make sure it is a jQuery bug
  43
  44 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.
  45
  46 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.
  47
  48 ### Disable browser extensions
  49
  50 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.
  51
  52 ### Try the latest version of jQuery
  53
  54 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.
  55
  56 ### Simplify the test case
  57
  58 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.
  59
  60 ### Search for related or duplicate issues
  61
  62 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.
  63
  64
  65 ## Tips For Bug Patching
  66
  67 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.
  68
  69 ### Build a Local Copy of jQuery
  70
  71 Create a fork of the jQuery repo on github at https://github.com/jquery/jquery
  72
  73 Clone your jQuery fork to work locally
  74
  75 ```bash
  76 $ git clone git@github.com:username/jquery.git
  77 ```
  78
  79 Change directory to the newly created dir jquery/
  80
  81 ```bash
  82 $ cd jquery
  83 ```
  84
  85 Add the jQuery main as a remote. I label mine "upstream"
  86
  87 ```bash
  88 $ git remote add upstream git://github.com/jquery/jquery.git
  89 ```
  90
  91 Get in the habit of pulling in the "upstream" main to stay up to date as jQuery receives new commits
  92
  93 ```bash
  94 $ git pull upstream main
  95 ```
  96
  97 Install the necessary dependencies
  98
  99 ```bash
 100 $ npm install
 101 ```
 102
 103 Build all jQuery files
 104
 105 ```bash
 106 $ npm run build:all
 107 ```
 108
 109 Start a test server
 110
 111 ```bash
 112 $ npm run test:server
 113 ```
 114
 115 Now open the jQuery test suite in a browser at http://localhost:3000/test/.
 116
 117 Success! You just built and tested jQuery!
 118
 119 ### Test Suite Tips...
 120
 121 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.
 122
 123 Example:
 124
 125 http://localhost:3000/test/?module=css
 126
 127 This will only run the "css" module tests. This will significantly speed up your development and debugging.
 128
 129 **ALWAYS RUN THE FULL SUITE BEFORE COMMITTING AND PUSHING A PATCH!**
 130
 131 #### Change the test server port
 132
 133 The default port for the test server is 3000. You can change the port by setting the `PORT` environment variable.
 134
 135 ```bash
 136 $ PORT=3001 npm run test:server
 137 ```
 138
 139 #### Loading changes on the test page
 140
 141 Rather than rebuilding jQuery with `npm run build` every time you make a change, you can use the included watch task to rebuild distribution files whenever a file is saved.
 142
 143 ```bash
 144 $ npm start
 145 ```
 146
 147 Alternatively, you can **load tests as ECMAScript modules** to avoid the need for rebuilding altogether.
 148
 149 Click "Load as modules" after loading the test page.
 150
 151 #### Running the test suite from the command line
 152
 153 You can also run the test suite from the command line.
 154
 155 First, prepare the tests:
 156
 157 ```bash
 158 $ npm run pretest
 159 ```
 160
 161 Make sure jQuery is built (`npm run build:all`) and run the tests:
 162
 163 ```bash
 164 $ npm run test:unit
 165 ```
 166
 167 This will run each module in its own browser instance and report the results in the terminal.
 168
 169 View the full help for the test suite for more info on running the tests from the command line:
 170
 171 ```bash
 172 $ npm run test:unit -- --help
 173 ```
 174
 175 ### Repo organization
 176
 177 The jQuery source is organized with ECMAScript modules and then compiled into one file at build time.
 178
 179 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.
 180
 181 ### Browser support
 182
 183 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.