Skip to content

Status Report #1 Repository Overview

Oğuz Kaan Yüksel edited this page Oct 2, 2018 · 1 revision

Date: 28.05.2018

1. Status

  • 1.1. The current README document is simple but effective. It has links to various important pages in the repository, like the Wiki, issues, requirements, plan etc. Moreover, it briefly describes the project and lists the team members.

  • 1.2. The wiki has a similarly simple main page. It also has a useful sidebar with links to all the important pages in the wiki. A point not to miss: the icons in the wiki's sidebar are really cool...

  • 1.3. Some of the personal pages are a bit dull. But they all have at least a brief description and contact information.

  • 1.4. We settled the main lines or rules of our workflow -which may have changed in part by the process of getting to know each other and the project better- and clear descriptions of issue and commit format have been made as documents in the wiki.

  • 1.5. Labels chosen during this milestone have proved themselves useful and sufficient during the rest of the semester. Only 1 or 2 new labels have been created and main labels have been used extensively.

  • 1.6. "Learn Git" and "Git Cheat Sheet" documents were created by those members who were familiar with Git. These documents explain the basics of Git and have a lot of resource references to continue learning Git.

2. Difficulties

  • 2.1. Being completely new to GitHub, some of us had difficulty choosing good repositories, better said, with the concept of good and bad repositories. But the difference of the state of the repository before and after this milestone has given an idea about the concept.

  • 2.2. We initially had difficulty about preparing a good README file and wiki page. Demands from the Customer -who was naturally most complainant of the cumbersomeness of our wiki page- have helped make the repository a better place for all.

3. Acquirements

  • 3.1. This work has taught a lot of us what Git and GitHub are for the first time and got our hands dirty with a repository, which is a huge improvement on a computer science student.

4. Suggestions

  • 4.1. We are currently seeking broken or empty links in the repository. This should be gotten rid of.
  • 4.2. It would be a good idea to add links to the Milestones page and the semester final review report, which we will work on after finishing the report.
Clone this wiki locally