Fixing an Issue

duclet edited this page Feb 3, 2012 · 1 revision

If you found an issue and would like to provide a fix for it, this guide will guide you thru what needs to be done. But first, we would like to say thank you for helping us. It is very much appreciated. But note that we may not accept your pull request right away as we will be code reviewing it and putting it thru a round of testing first. We may also delay the acceptance to a later release if we feel it is more appropriate. Anyway, please follow the guidelines below.


  1. The first step is to create a fork of the jQuery Tools repository on GitHub so you'll have your own copy of it.
  2. If this is the first time you fork, you can skip this step. If not, you'll want to update your repository so that it has gotten all the updates from our repository. The only branch you'll want to update though is the dev branch.
  3. You'll now want to create a new branch (please do this for each issue) based off the dev branch.
  4. Make your changes and test your code.
  5. Commit your code and push your changes to your repository.
  6. Create a JsFiddle or update the one from the issue with your fix and post to the ticket.
  7. After others have tested and confirm to be working, issue a pull request to the dev branch from your branch.

It is important that you create a new branch off the dev branch each time for a new issue. You should not be coding in the dev branch directly either. This will make it so that the merge into the dev branch only contains commits relating to the issue and nothing else when you make the pull request.

While the code isn't yet in this state, it will be updated so that there will be plenty of inline documentation stating what the code does. We believe this makes it easier for developers to look at and quickly and easily understand the code. As such, when coding, be sure to add in comments where needed.