21
edits
Changes
→Command line or GUI Tools
{{OOP344 Index | 2012320131}}
'''''UNDER CONSTRUCTION'''''<br />
This page is to give a brief guideline of how to use '''''github''''' for OOP344 or other school projects.
=Command line Or or GUI Tools=
Please use any of the Tools you are more comfortable to work with git.
There are several GUI interfaces that may make working with git easier for you.
here are few examples: (feel free to add more if you know of any):
* [http://windows.github.com/ GitHub for Windows]
* [http://plasticscm.com/labs/gitjungle.aspx Git Jungle] Linux
* [http://maketecheasier.com/6-useful-graphical-git-client-for-linux/2012/01/18 Linux Gui Git]
* [http://code.google.com/p/tortoisegit/wiki/Download Tortois Git] (Windows[recommended])** [http://www.youtube.com/watch?v=pp2S2lHjzZI How to setup Tortois Git to work with Github]
* [http://sourceforge.net/projects/gitextensions/ Git Windows Explorer plugin] (windows)
* [https://github.com/blog/878-announcing-github-for-mac github for Mac] (Mac)
* [http://www.syntevo.com/smartgit/index.html;jsessionid=7C7BC9351DEE9338FDF7AA353E8E93C2 Smart Git] (Windows, Mac, Linux)
* [http://gitx.frim.nl/ GitX] (Mac)
* [http://www.sourcetreeapp.com/ SourceTree] (Mac)
=Resources=
* Amazing article on how the work is done on a project using git branching. Read this and you will understand how it is done:[http://scottchacon.com/2011/08/31/github-flow.html Scott Chacon' Github Flow ]
* http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging
* [http://www.youtube.com/watch?v=JXusZR41Je0 Lecture Video]
=Teams and their Repository=
Logging to your github account you will notice that you are now member of a team that carries a similar name to your team name. Also you have full access to a repository with the same name.
=cloning Clone the repository=The first step is to clone the project repository , since it contains the initial files to start the project.
<big><pre>
git clone git@github.com:Seneca-OOP344/REPONAME.git
</pre></big>
REPONAME is the name of the project repository on github
=Assign the issues=
#check the [[The CIO Framework#Issues.2C_Releases_and_Due_Dates|Issues]] on [[The CIO Framework]] page and assign each of them to two members, one for development and another for code review and pulling the code back to master repository
#list all the issues in your team page that is built based on [[Team page template - oop344 20123|the team page template]].
#create the issues on github assigning them to the team members
#: It is recommended to create a milestone and attach /assign it to the issue for follow up
=Branch the master repository=
#Each team member now branches the master repository under a relative name to the issue she/he is working on.
#:<big><pre>git branch IssueNameOrID</pre></big>
#switch your repository to the branch created
#:<big><pre>git checkout IssueNameOrID</pre></big>
#: Start your work and do the first '''add''' and/or '''commit'''
#push the branch back to github
#:<big><pre>git push --set-upstream origin IssueNameOrID</pre></big>
==Links==
* http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging
=Work on the issue=
# Never work on the master branch.
# Start working on the issue in the branch related to the issue committing regularly
# Push the changes to the branch back to github constantly to share.
#: By doing this you can discuss your code and problems with your professor and team members and also demonstrate your work habits.
=Pull request=
#push final changes to github
#when task is completed create a pull request to merge back the branch to the master repository.
#assign the pull request to the team member responsible for code review
=Review the code=
This is done by the student assigned to review this code
#Review the code and make sure it is proper and is working as defined in the issue.
#Share your concerns with your team-mates through the discussion board, attached to the issue/pull request.
#If there is problem, ask the person who wrote the code to revise and correct the mistakes
=Merge the code back to master repository=
#when ready, merge the branch back to the master branch
## Switch back to master
##: <big><pre>git checkout master</pre></big>
## make sure to pull all changed to your master from the server before merging
## merge
##: <big><pre>git merge IssueNameOrID</pre></big>
#resolve possible conflicts
#test the master repository one last time
#push changes back to github
#close the pull request.
==Links==
http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging
http://itactics.wordpress.com/2012/11/07/setting-up-git-local-and-github/ by DH, about problems when setting up SSH Key and cloning.
=Pull the new changes to Local master repositories=
Now all the team members call pull the changes into their local master repositories and branch for the next issue