First steps to gitHub, need some help adding bugfixes
Let's say I would like to help out, with for example reducing the amount of bugs in documentation. I have found a bug in the openCV dev area and am going through the steps suggested at 'How to contribute'.
And there I loose what to do next :) Following these instructions:
- Choose a base branch for your work.
- Create a new branch (with a meaningful name) from the base branch you chose.
- Modify/add the code following our Coding Style Guide.
- When you are done, push your branch to your GitHub fork; then create a pull request from your branch to the base branch.
First of all, how do I choose the branch for my work when using Windows & TortoiseGIT? What I did now is creating a folder on my root, rightclick 'clone git', adding my GitHub fork of openCV and setting my branch to 2.4. Then it synchronizes for some time. Is this correct?
Next I need to create a new branch, and being new to this all, I find no way in doing so. Do you do this on your system or online at the GitHub site? Can someone point me in the correct direction?
About modifying the files, in my case documentation, it seems to be LaTeX files, which I can work with, but I have trouble locating the correct files in my file structure. Where should I look for these files exactly?
Pushing back my branch when adapted, can someone guide me on how to do that exactly.
These are merely the steps I cannot find amongst the guides, leading me to problems going further. Maybe if the solutions are added here, someone could update the contribute guide.
seems all well, so far. the missing buttons are in the context menu_Context_menu) for your cloned folder. (right click)
And you have a clue on which files to edit for documentation? So far I have found where source code is, but not the documentation part :)
i think it gets generated from the .rst files in the module/doc folders, e.g. here
I think OpenCV needs better tutorials for this kind of stuff
@yes123 i could not agree even more :)
Hi, guys! It's really a hot topic (as you can see, the "history" of "How to contribute" page is frequently updated last time)! If you have some experience with git, it's not a problem to make a pull request to OpenCV with current instruction, but adding illustrated instruction for some popular clients is a good idea (something like answer (http://answers.opencv.org/question/6495/visual-studio-2012-and-rtlfreeheap-error/?answer=6603#post-id-6603) by @Hongbo Miao). These tutorials can be placed at the bottom of "How to contribute" page. Will anyone join this work?
I can help you create a tutorial for tortoiseGIT & Windows 7 if you want to. After that send them to you by mail or?
Hi, Steven! Great! I'm think, it will be useful, if you add a question here and post the answer on it, like in link above. I will update "How to contribute" page with this answer.
I will post it here as an answer tomorrow :)
Ok, looking forward to!