GitHub Usage - Akamoha/OOP-Resources GitHub Wiki

This page contains proper GitHub usage guidelines for OOP Project.

##Add Group Members to Project The first step is to provide administrator permissions to the group repository to all members of your group. You can do this going to

Project Page --> Settings --> Collaborators Select the team; the team is usaully your group number.

On team members page, look for text box containing "invite or add users to team" and type in the usernames of your group members. If the user exists with the given username, you will shown the user in a drop dox box. You can add the user to your team by clicking on the user.

##Submissions

Periodically you will be asked to submit project documents through git commits. Git allows you to develop using branch-merge or fork-push-pull model. Such a development model is very useful for code development. But if I were to download your commits for evaluation, the situation becomes hazy. What branch do I pull/clone? By convention I will pull master branch for evaluation. Please merge all your submissions to master branch before deadline.

##Git / GitHub Tutorials

Git and GitHub has extensive usage tutorials. If you are short on time, you can try short tutorials available at

  1. Try Git tutorial

  2. Git simple guide

  3. GitHub Guides

A longer and more complete version is available as Pro Git book.

##Project Documentation You can use the project wiki (you are looking at one right now) to do concurrent documentation for your project. GitHub also provides GitHub Pages facility. You can use these two platforms as excellent documentation facilitators. These can neatly supplement your javadoc.

##Issues and Milestones You are expected to keep track of development, bugs and todos using issue tracker. A nice tutorial on issue tracker is available at Mastering Issues, available as part of GitHub Guides. GitHub provides few useful labels. You are advised to add usecases, UML, unit tests labels to already existing labels. You are also advised to add a design document, iteration-1, iteration-2, final milestones to help create a working demonstrations for evaluation purposes. As an aside git itself allows version tags to code commits. You may use that as well.