Project: Track-O

Track-O is a desktop address book application used by private tutors to schedule lessons and track payments. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 17 kLoC.

Given below are my contributions to the project.

  • Add and clear remarks: Added the ability to add and clear remarks for Tutees.
    • What it does: allows the user to add informal remarks and clear them as necessary.
    • Justification: Allows the user to add information that may not be reflected in the fields given, such as work progress, homework assigned or questions asked. Information also need not be limited to a single line or paragraph and multiple sets of information can be added using remarks.
    • Highlights: Adding remarks appends new remarks to existing remarks instead of replacing them. Using the clearremark Command clears all remarks.
    • Credits: Initial implementation from AB3 tutorial and Yangken

  • School field: Added a school field to Tutee.
    • What it does: Tutors can now save infomration about a tutee’s school when adding them to Track-O.
    • Justification: Having information about what school a tutee is from will help tutors plan their lessons more efficiently, such as by planning their schedules based on the timetables of different schools or by catering to different school’s students differently based on how their syllabus is covered in school.
    • Highlights: This enhancement affects existing commands such as add and edit as a new field is added, leading to an increase in the number of parameters these commands take in.
    • Credits: -

  • Code contributed: RepoSense link

  • Project management:
    • Ensure the quality and format of the deliverables.

  • Enhancements to existing features:
    • Refactor AB3 to change all instances of Person to Tutee and AddressBook to TrackO #43
    • Update help command to make it more reader-friendly #84

  • Documentation:
    • User Guide:
      • Added documentation for remark and clearremark commands #107
    • Developer Guide:
      • Add in target user profile, value proposition and user stories #13
      • Amend UML diagrams to reflect Tutee and TrackO instead of Person and AddressBook respectively #64

  • Community:
    • PRs reviewed (with non-trivial review comments): #37, #99, #162, #172
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)