Project: contHACKS

contHACKS is a desktop app for Teaching Assistants (TAs) to manage contacts and lessons. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 12 kLoC.

Given below are my contributions to the project.

New Feature: Added the ability to find a lesson. (PR #141)

  • What it does: Allows the user to find a lesson within contHACKS by providing information about the lesson.
  • Justification: This feature improves the product significantly as user can now find the relevant classes based on their searches from contHACKS.
  • Highlights: On top of searching using the lesson’s module code, you can also search via the lesson’s start time and the day of the week of the lesson. The once obsolete tag prefix t/ was recycled to be used to search for lesson start time.
  • Credits: The design structure is inspired from AddressBook Level 3

Enhanced Feature: Enhanced the ability to find person. (PRs #51, #76, #84)

  • What it does: Allows the user to find person from contHACKS with different information quickly by allowing partial word matches.
  • Justification: User now need not type the full name just to search for a single person, making the process faster especially for long names.
  • Justification: While this might return more entries per search, it is still not significantly long enough to affect search experience.

Team-Based Tasks:

  • Refactored moduleClass class to moduleLesson class. (PR #98)

Code contributed: RepoSense link

Project management:

  • Helped to regulate and ensure the proper workflow in the project
  • Guided the general direction of where project should move towards

Testing:

Documentation:

  • User Guide:
    • Added documentation for the features find: #116, #146
    • Created a structure and added documentation for the feature findc: #152
  • Developer Guide:
    • Refine product scope and use cases: #16
    • Update implementation of find feature: #110

Community: