tp

Siew Shui Hon’s (blackmirag3) Project Portfolio Page

Project: Classify

Overview

Classify is a desktop-based CLI application used for Tuition Centres to allow for easier management of their enrolled students. Classify is the one-stop app that all Tuition Centres can employ for ease of student management.

Summary of Contributions

• Code Contributed
  • blackmirag3’s RepoSense
• Enhancements Implemented
  • Feature: Edit
    • Added base feature to access students’ attributes and details.
    • Implemented sub-features such as adding, removing or editing existing subjects.
  • Feature: Archive and Unarchive
    • Implemented archiving and unarchiving feature.
    • Implemented DataHandler class to manage reading and writing of archived students within a data file.
  • Non-features:
    • Implemented SubjectGrade class.
    • Wrote EditTest class to test edit feature.
    • Implemented helper functions and exceptions re-used by the team, such as:
      • findSubject method which finds whether a subject exists under a student
      • isValidGrade method which validates input format for grade.
      • InvalidSubjectException exception which prevents duplicate subjects. Used by AddSubject and EditSubject classes.
• Contributions to UG
  • Wrote for edit, archive, unarchive features.
  • Finalised formatting in UG, such as standardising the layout under Usage section.
• Contributions to DG
  • Wrote EditStudent and ArchiveCommands component
  • Wrote Archiving/unarchiving a student and Editing a student's details manual testing.
  • Created UML sequence diagram for ‘EditStudent’ and ‘ArchiveCommands’ component each.
• Contributions to Team-Based tasks:
  • Refactored/rewrote at least 300 LoC (authored by teammates) to improve code quality, such as for input checking and file IO.
  • Established TP’s current code organisation, such as refactoring project into respective packages commands, data, ui etc.
  • Maintained team’s GitHub Project, such as updating status and priority of project items.
• Review/mentoring contributions
  • Actively reviewed and approved team’s PRs, with some recent examples here or here.
• Contributions beyond project team
  • Did exploratory testing of T13-4’s TP before their final release.