Project: Class-ify

Class-ify is a class management application built specially for Singapore Ministry of Education (MOE) teachers to monitor their student’s academic progress easily. Teachers can generate exam statistics for each class, and Class-ify quickly flags out students who require more support for contacting.

It is written in Java and the GUI is built using JavaFX.

My contributions to the project are documented below.

Code contributed

RepoSense link

Enhancements implemented

  • Refactor AB3 DeleteCommand to delete student records by the student’s name or student ID in #91, #179
    • AB3’s DeleteCommand deletes each item in the list by its index. By changing the command to delete each item in the list by a more unique detail such as a student’s name or student ID, it reduces errors in deletion.
  • Updated test cases for DeleteCommand in #91
  • Refactor AB3 HelpCommand to show command summary table in #150
    • AB3’s HelpCommand only shows a link to its user guide. By adding a reference to a command summary table in the help window, it becomes more useful for the user.

Contributions to the User Guide

  • Update documentation for DeleteCommand in #30, #97, #241, #256
  • Update command summary table in #97, #120, #148, #181
  • Add introduction and glossary section in #141
  • Update documentation for HelpCommand in #241
  • Revise structure of user guide in #250

Contributions to the Developer Guide

  • Add introduction section in #126, #247
  • Add implementation details and design considerations for DeleteCommand in #157, #252
  • Update UML diagrams in architecture section in #160, #178
  • Update instructions for manual testing in #163
  • Add use cases in #252

Review/mentoring contributions

  • Reviewed my team members’ pull requests and provided suggestions to improve code quality
  • Total pull requests reviewed: 27

Contributions beyond the project team

  • Provided useful feedback on user guides and developer guides from other teams in our tutorial group
  • Reported bugs for team Salesy