Project: TutorPro Level 1

TutorPro - Level 1 is a desktop contact management application used for managing students as a Private Tutor. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

Given below are my contributions to the project.

  • New Feature: edit command
    • What it does: Allow users to edit any field of a person.
    • Justification: This feature improves the functionality of the product significantly because it allows user to rectify mistakes in their commands and also update old information.
    • Highlights: Users can edit more than one field in a single edit command which boosts the product’s efficiency.
  • New Feature: Add grade to subject /#53
    • What it does: User can now add a grade to a subject when adding or editing the <SUBJECT> field.
    • Justification: This allows users to keep track of their students’ academic progress efficiently.
    • Highlights: Modified the <SUBJECT> field such that there is more flexibility where subjects with longer names and grades with more than a single letter are accepted as valid inputs.
  • Enhancements to existing features:
    • Saving and Loading feature /#46
      • Added JsonAdaptedSubject and JsonAdaptedStudent to ensure all information are saved and loaded properly. —

  • Code contributed: RepoSense link

  • Project management:
    • Managed releases v1.1 and v1.2 (2 releases) on Github
  • Documentation:
    • README:
      • Set up CI status and codecov badge
      • Made UI mockup of our intended final product.
      • Update all contents to match our project.
      • Acknowledge the original source of the code.
    • User Guide:
      • Added documentation for Table of Contents, Command Summary, and FAQ /#66
      • Added hyperlink to ToC for every header to boost functionality.
      • Added documentation for future feature schedule. /#156
      • Tweak documentation for features edit, remind and event /#149 /#157
      • Did cosmetic tweaks to existing documentation
    • Developer Guide:
      • Updated PUML diagrams
  • Community:
    • PRs reviewed (with non-trivial review comments): /#18 /#31 /#40 /#42 /#43 /#48
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)