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
  14 ## Getting Involved
  15
  16 [API design principles](https://github.com/jquery/jquery/wiki/API-design-guidelines)
  17
  18 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.
  19
  20 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.
  21
  22 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).
  23
  24 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+is%3Aopen+label%3A%22help+wanted%22%2C%22Patch+Welcome%22).
  25
  26 ## Questions and Discussion
  27
  28 ### Looking for help?
  29
  30 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.
  31
  32 The jQuery Core team watches [jQuery GitHub Discussions](https://github.com/jquery/jquery/discussions). 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://matrix.to/#/#jquery_dev:gitter.im) Matrix channel on gitter.im.
  33
  34 ### Weekly Status Meetings
  35
  36 The jQuery Core team has a weekly meeting to discuss the progress of current work. The meeting is held in the [#jquery/meeting](hhttps://matrix.to/#/#jquery_meeting:gitter.im) Matrix channel on gitter.im at [Noon EST](https://www.timeanddate.com/worldclock/fixedtime.html?month=10&day=7&year=2024&hour=12&min=0&sec=0&p1=43) on Mondays.
  37
  38 [jQuery Core Meeting Notes](https://meetings.jquery.org/category/core/)
  39
  40
  41 ## How to Report Bugs
  42
  43 ### Make sure it is a jQuery bug
  44
  45 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.
  46
  47 Ask for help first on a 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.
  48
  49 ### Disable browser extensions
  50
  51 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.
  52
  53 ### Try the latest version of jQuery
  54
  55 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.
  56
  57 ### Simplify the test case
  58
  59 When experiencing a problem, [reduce your code](https://webkit.org/test-case-reduction/) 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.
  60
  61 ### Search for related or duplicate issues
  62
  63 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.
  64
  65
  66 ## Tips For Bug Patching
  67
  68 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.
  69
  70 ### Build a Local Copy of jQuery
  71
  72 Create a fork of the jQuery repo on GitHub at https://github.com/jquery/jquery
  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 `main` 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" main to stay up to date as jQuery receives new commits:
  93
  94 ```bash
  95 $ git pull upstream main
  96 ```
  97
  98 Install the necessary dependencies:
  99
 100 ```bash
 101 $ npm install
 102 ```
 103
 104 Build all jQuery files:
 105
 106 ```bash
 107 $ npm run build:all
 108 ```
 109
 110 Start a test server:
 111
 112 ```bash
 113 $ npm run test:server
 114 ```
 115
 116 Now open the jQuery test suite in a browser at http://localhost:3000/test/.
 117
 118 Success! You just built and tested jQuery!
 119
 120 ### Test Suite Tips...
 121
 122 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.
 123
 124 Example:
 125
 126 http://localhost:3000/test/?module=css
 127
 128 This will only run the "css" module tests. This will significantly speed up your development and debugging.
 129
 130 **ALWAYS RUN THE FULL SUITE BEFORE COMMITTING AND PUSHING A PATCH!**
 131
 132 #### Change the test server port
 133
 134 The default port for the test server is 3000. You can change the port by setting the `PORT` environment variable.
 135
 136 ```bash
 137 $ PORT=3001 npm run test:server
 138 ```
 139
 140 #### Loading changes on the test page
 141
 142 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.
 143
 144 ```bash
 145 $ npm start
 146 ```
 147
 148 Alternatively, you can **load tests as ECMAScript modules** to avoid the need for rebuilding altogether.
 149
 150 Click "Load as modules" after loading the test page.
 151
 152 #### Running the test suite from the command line
 153
 154 You can also run the test suite from the command line.
 155
 156 First, prepare the tests:
 157
 158 ```bash
 159 $ npm run pretest
 160 ```
 161
 162 Make sure jQuery is built (`npm run build:all`) and run the tests:
 163
 164 ```bash
 165 $ npm run test:unit
 166 ```
 167
 168 This will run each module in its own browser instance and report the results in the terminal.
 169
 170 View the full help for the test suite for more info on running the tests from the command line:
 171
 172 ```bash
 173 $ npm run test:unit -- --help
 174 ```
 175
 176 ### Repo organization
 177
 178 The jQuery source is organized with ECMAScript modules and then compiled into one file at build time.
 179
 180 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.
 181
 182 ### Browser support
 183
 184 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.