Project: SunRez

SunRez is a resident management system for use in hostels and residential colleges (RCs). The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 19 kLoC.

Given below are my contributions to the project.

  • New Feature: Added support for issues
    • What it does: The issue feature allows the user to track issues that pertain to certain rooms in SunRez.
    • Justification: This feature is needed as Users need to be able to keep a record of issues that happen to rooms so as to address them. The ability to see a record of issues also allows the user to identify rooms that maybe prone to damages.
    • Highlights: This feature entailed an intermediate amount of considerations in how it would integrate with the room feature due to issues being tied to rooms. Although it is not heavily coupled with rooms, future adjustment to rooms need to take into account how issues might be affected.
  • Enhancements to existing features:
    • Allow text to wrap when it is too long in the ListPanel #326.
    • Limit tag lengths to prevent tags from being too long does being unreadable #329.
  • Code contributed: RepoSense link

  • Contributions to User Guide:
  • Contributions to Developer Guide:
    • Wrote uses cases UC-012 to UC-016. #48
    • Updated UI component’s class diagram and implementation details to reflect the latest version of SunRez. #414, #426
    • Added Activity, Sequence, and Class Diagrams for issue feature. #117
    • Added manual testing instructions for issue feature. #394
    • PRs made for documentation
  • Team tasks:
    • Introduced Conventional Commits and discussed its usage pertaining to the project.
      • Conventional Commits is to standardize commit messages so as to help with understanding what the commit is about.
    • Set up user stories and tasks for the team in various sprints.
  • Community:
  • Tools:
    • Integrated Visual Studio Code (#12).
    • Integrated GIT pre-commit (#54) hook to ensure tests and check style pass before commits are made to reduce breaking commits and reduce github CI fail test checks.