GIT for OOP344 Projects

OOP344 | Weekly Schedule | Student List | Teams | Project | Student Resources
UNDER CONSTRUCTION
This page is to give a brief guideline of how to use github for OOP344 or other school projects.

Command line 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):

• Git Jungle Linux
• Linux Gui Git
• Tortois Git (Windows)
• Git Windows Explorer plugin (windows)
• github for Mac (Mac)
• Smart Git (Windows, Mac, Linux)
• GitX (Mac)

• SourceTree (Mac)

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 the repository

The first step is to clone the repository since it contains the initial files to start the project.

git clone git@github.com:Seneca-OOP344/REPONAME.git

REPONAME is the name of the project repository on github

Assign the issues

1. check the 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
2. list all the issues in your team page that is built based on the team page template.
3. 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

1. Each team member now branches the master repository under a relative name to the issue she/he is working on.

   git branch IssueNameOrID

2. switch your repository to the branch created

   git checkout IssueNameOrID

3. push the branch back to github

   git push --set-upstream origin IssueNameOrID

Very Important Note regarding working on anissues

1. Never work on the master branch.
2. Always create a branch to do the work in.
3. Constantly push the work back to github

   (Like pressing the save button on an editor)

4. when it is done, create a pull request for someone else to check the code and merge it back to the master branch
5. when it is merged, then pull the changes to master
6. pickup another issue and go the step one.

Work on the issue

1. start working on the issue committing the work regularly
2. push the changes to the branch on github to share, discuss your code and problems with your professor and team members

Pull request

1. push final changes to github
2. when task is completed create a pull request to merge back the branch to the master repository.
3. assign the pull request to the team member responsible for code review

Review the code

1. check out the code and make sure it is proper and working to your best knowledge.
2. share your concerns with your team-mates through the discussion board of attached to the issue/pull request

Merge the code back to master repository

1. when ready, merge the branch back to the master branch
2. resolve possible conflicts
3. test the master repository one last time
4. close the pull request.