First steps to gitHub, need some help adding bugfixes

edit

Specific instructions to contribute for Windows 7 & TortoiseGIT

System configuration

• Windows 7 x64 bit operating system
• GIT 1.8.1 & TortoiseGIT 1.8.4

Prerequisites

1. Register at GitHub
2. Download & install GIT
3. Download & install TortoiseGIT

First configure your GitHub page to fork the original openCV repository.

1. Go to GitHub
2. Open the Itseez OpenCV page
3. Press the fork icon on the right hand top side of the page.

Create a folder on your system to sync up the openCV source code from your fork

• Create a folder named 'opencv_source' in your systems root path (or your own selection)
• Right click on the folder, selecting the Git Clone option

• Fill in the proper information into the configuration panel. Replace my username with your GitHub username and remove the extra opencv folder that is added to the directory structure.

• Press OK and let the folder sync up, until full synchronization has passed.

Create a new branch on your Git repository, to apply changes. Do not forget to create a new branch for every single update you want to do! These branches are local, but will be pushed to github after editing the source code.

• Right click on folder
• Select TortoiseSVN > Create Branch

• Select the correct options, choose a correct name for your branch, base it on the master branch for complete new functionality, or for minor fix, base it on 2.4 branch.

• Hit the OK button and let it configure your repository. Changes might not change immediatly on the GitHub page, because it sync's in a lapsed time interval. Don't worry about that.

Select the file you want to adapt (in our case I will illustrate adding an extra comment to a source code file), adapt the the file accordingly and commit it to your GitHub repository.

• In your configured GitHub folder on your machine, adapt the file you want.
• In our case, we open up the file C:\opencv_source\apps\traincascade\traincascade.cpp
• Add your lines of code to the source code.

• Save the file so that your adaptations are stored onto the system.
• Your folder will indicate that a change has been made, by placing an exclamation mark.

• Commit your adapted file to GitHub by selecting the commit->bugfix_1 option.

• The first time, the system will ask you to input your username and email, giving the following warning. Press Yes, fill in credentials and press OK.

• A commit window of TortoiseGIT will appear, showing you the files that were adapted. It requires you to give a complete but brief description of your adaptation, then allows you to push the file. Select only the files you want to commit to the repository!

• At the next window, explicitly tell the software to push the adaptations!

• An interface will pop up to push the data and local branches (which you made earlier). Be sure to select the option to push all branches.

Your system is now all sync'd up with GitHub, lets make sure by checking.

• The branch you created for ...