Jcrop Developers

Fork or follow Jcrop on github

The best way to keep up with the project is on github. The master branch will always have the most current published version of Jcrop, and release versions will be tagged, if you feel more comfortable with that.

If you want to develop enhancements and keep up with changes, fork the project on github.

Seriously, if you do not use git, you owe it to yourself to learn this tool! I have used other version management tools and comparatively I think git makes a lot more sense. Plus, github provides a great interface for free projects.

  • Create a github account if you do not have one. Login.
  • Fork the project on github using the web interface.
    • This will create your own unique git repository that is a clone of the Jcrop project
  • Clone that git repository somewhere that you are working. (Your local machine, for example.) 
   $ git clone git://github.com/yourrepourl
  • Make your edits

At this point, you are maintaining a fork of the project at whatever point you forked it. If you want to merge changes from the master repository you could do a git fetch to another branch: 

   $ git fetch git://github.com/tapmodo/Jcrop.git master:jcropx
   $ git merge jcropx

Here, as an example, the master branch from the main project is fetched into a new local branch named jcropx. Then that branch is merged into the current working branch. After merging, you can delete that branch with: 

   $ git branch -d jcropx

You can maintain your forked version in this manner as long as you want. When you have made your changes and would like to publish them (to your forked repository), simply use git push: 

   $ git push origin master

Suggesting code changes or submitting bug fixes

When you have pushed your changes to a forked repository on github, you may submit a pull request to the project using the github web interface. What this means is you are requesting a review of your changes for possible inclusion into the project.

I will be notified of the pull request and I will review it. A few things to note about how I respond to pull requests:

  • It may take me a while to review and decide on the changes
  • The changes may be integrated verbatim, with slight modifications, or not at all
  • The request will probably not be automatically merged, but...
  • I would like to include your name and email as the author of that commit

Submitting code changes or bug fixes without using git

Another way you can send updates is to send a diff/patch of your modifications. If this is not possible, alternatively you may send the entire changed file via email. The email address is listed in the source code.

Thanks to everyone who has helped contribute to the project and make it great!

Retrieved from "http://www.deepliquid.com/content/Jcrop_Developers.html"