Git Usage Report

Contents

• Github Usage
• Git Usage
• Clean Code
• Add Function

---

Github Usage

• Issues
• MileStone
• Wiki
• Github Pages
• Pull requests

---

Issues

• We create duplicated named issues to create new branch when previous issues is merged with master.
• Manage Issues with format like [Category] Title.
• Assign 'Assignees', 'Milestone', 'Labels' to each issues.
• You can see example in here.

---

MileStone

• We manage Issues with Milestone.
• We assign one or more issues to Milestone.

---

Wiki

• We write two sub-Wiki :
  • Technical Wiki : Mainly about introducing Snake game Algorithm, License and detailed Installation Guide.
    (Readme's Installation Guide is not detailed)
  • Git Usage Wiki : Mainly about how we did project.

---

Github Pages

• We create homepage to introduce Snake Game.

• It can be accessable in main repository page :

---

Pull requests

• We manage Pull requests when branch is needed to merge.
• We Integrated naming [Issues]-[branch name]-[Pull requests].

---

Git Usage

• Merge Policy
• Branch Name Policy
• Commit message Policy
• Merge History

---

Merge Policy

• We ruled Merge if more than two team members should give emoticon in Pull Request.
• Merge Master and Branch, then Push Master branch to remote resipotory.
• All Merge is done locally in Git.

---

Branch Name Policy

• We ruled Branch Name as issue/issue_#num
• You can see example in here

---

Commit message Policy

• All commit messages naming #issue .
• You can see example in here.

---

Merge History

• Above image is our Merge History.

• We ruled to follow below Merge rule :

  • Fetch & Merge -> Create new branch -> Modify some code -> Merge with Master -> Fetch & Merge -> Push

• We followed above rule almost, but there are some exception.

---

Clean Code

• Remove Duplicated Code
• Remove 1 line 2 statements
• Add Comments

---

Remove Duplicated Code

• We replace duplicated code into function
• You can see changes in this milestone under the Issues/commits.

---

Remove 1 line 2 statements

• We remove 1 line 2 statements
• You can see changes in this milestone under the Issues/commits.

---

Add Comments

• We add comments to code
• You can see changes in this milestone under the Issues/commits.

---

Add Function

• Add Menu GUI
• Modify Direction Key

---

Add Menu GUI

• Implement Menu GUI, so you can select mode before game start.
  • Before : Must change code to change mode.
  • After : Before game start, can select the mode.

---

Modify Direction Key

• We fix Direction Key
  • Before : Can't move Snake when Caps Lock is on in manual mode.
  • After : Can move Snake when Caps Lock is on in manual mode.

---