Note: This is the code development repository for jqrony Core only. Before opening an issue or making a pull request, be sure you're in the right place.
- jqrony plugin issues should be reported to the author of the plugin.
- jqrony Core API documentation issues can be filed at the API repo.
- Bugs or suggestions for other jqrony organization projects should be filed in their respective repos.
We're always looking for help identifying bugs, writing and reducing test cases, and improving documentation. And although new features are rare, anything passing our guidelines will be considered.
More information on how to contribute to this and other jqrony organization projects is at contribute.jqrony.org, including a short guide with tips, tricks, and ideas on getting started with open source. Please review our commit & pull request guide and style guides for instructions on how to maintain a fork and submit patches.
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.
If you're looking for some good issues to start with, here are some issues labeled "help wanted" or "patch welcome".
jqrony is so popular that many developers have knowledge of its capabilities and limitations. Most questions about using jqrony can be answered on popular forums such as Stack Overflow. Please start there when you have questions, even if you think you've found a bug.
The jqrony Core team watches the jqrony Development Forum. 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. The Core team can be found in the #jqrony-dev IRC channel on irc.freenode.net.
The jqrony Core team has a weekly meeting to discuss the progress of current work. The meeting is held in the #jqrony-meeting IRC channel on irc.freenode.net at Noon EST on Mondays.
Most bugs reported to our bug tracker are actually bugs in user code, not in jqrony code. Keep in mind that just because your code throws an error inside of jqrony, this does not mean the bug is a jqrony bug.
Ask for help first in the Using jqrony Forum or another discussion forum like Stack Overflow. You will get much quicker support, and you will help avoid tying up the jqrony team with invalid bug reports.
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.
Bugs in old versions of jqrony may have already been fixed. In order to avoid reporting known issues, make sure you are always testing against the latest build. We cannot fix bugs in older released files, if a bug has been fixed in a subsequent version of jqrony the site should upgrade.
When experiencing a problem, reduce your code 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.
Go to the jqrony Core issue tracker and make sure the problem hasn't already been reported. If not, create a new issue there and include your test case.
We love when people contribute back to the project by patching the bugs they find. Since jqrony 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 jqrony 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.
Create a fork of the jqrony repo on github at https://github.com/jqrony/jqrony
Change directory to your web root directory, whatever that might be:
$ cd /path/to/your/www/root/Clone your jqrony fork to work locally
$ git clone [email protected]:username/jqrony.gitChange directory to the newly created dir jqrony/
$ cd jqronyAdd the jqrony main as a remote. I label mine "upstream"
$ git remote add upstream git://github.com/jqrony/jqrony.gitGet in the habit of pulling in the "upstream" main to stay up to date as jqrony receives new commits
$ git pull upstream mainRun the build script
$ npm run buildNow open the jqrony test suite in a browser at http://localhost/test. If there is a port, be sure to include it.
Success! You just built and tested jqrony!
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.
Example:
http://localhost/test/?module=css
This will only run the "css" module tests. This will significantly speed up your development and debugging.
ALWAYS RUN THE FULL SUITE BEFORE COMMITTING AND PUSHING A PATCH!
Rather than rebuilding jqrony 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.
$ npm startAlternatively, you can load tests as ECMAScript modules to avoid the need for rebuilding altogether.
Click "Load as modules" after loading the test page.
The jqrony source is organized with ECMAScript modules and then compiled into one file at build time.
jqrony 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.
Remember that jqrony supports multiple browsers and their versions; any contributed code must work in all of them. You can refer to the browser support page for the current list of supported browsers.