Project: SpamEZ

SpamEZ is a desktop app for managing contacts, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). It helps users to classify contacts based on their details in order to facilitate effective and efficient information dissemination to a large audience.

Given below are my contributions to the project.

  • New Feature: Added the ability to undo previous commands.
    • What it does: allows the user to undo previous commands one at a time.
    • Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
    • Highlights: Since it was decided to display the command that was undone in the late stages of the project, the previous implementation of the State class needs to be modified. A new class was introduced to accommodate for such changes too.
    • Credits: The implementation of this feature is mainly inspired from AB3 developer guide.
  • New Feature: Added a feature that allows the user to navigate to previous commands using up/down keys.
    • Justification: This feature reduces the memory work needed to remember some commands with many parameters such as add, edit etc. Users simply need to navigate to the previous commands and change the parameters instead of retyping everything.
    • Highlights: It was originally decided to implement this feature with the LinkedList class provided by Java. However, it was scraped and the feature is implemented with a self-made linked list instead due to a problem with how the linked list iterator works in Java.
  • New Feature: Making a person’s list view cell to turn black when the person is blacklisted.
    • Justification: This provides a visual response when the user decides to blacklist a contact.
    • Highlights: The current solution changes the css manually using setStyle() method as setBackground() did not work as intended. However, this causes some black lines appearing in the interface when the list of contacts is updated. Interestingly enough, the fix takes only one line of code.
  • New Feature : Display the mode of contact using an icon.
    • Justification: As the main focus of the application is to allow users to disseminate information to the contacts easily, it would be better to represent the mode of contact field using an icon instead of a text field.

  • Code contributed: RepoSense link

  • Project management:
    • Created the team repository.
    • Set up the CI for the project.
    • Reviewed and merged teammate’s pull requests.
  • Enhancements to existing features:
    • Adding support to find by other fields instead of only by name.
      • Justification: This enhancement is added to allow users to carry out mass operation on a certain group of contacts, e.g. all blacklisted contacts.
      • Highlights: This enhancement is the most tedious to implement as it allows users to find contacts by 7 fields at the same time. Furthermore, more test cases are needed to ensure this enhancement works correctly.
  • Documentation:
    • User Guide:
      • Added documentation for the undo and find commands and navigating previous commands: #70, #144
      • Clean up commands that are eventually not implemented: #142
    • Developer Guide:
      • Added implementation details of the undo and find feature: #52, #70
  • Community:
    • PRs reviewed (with non-trivial review comments): #60, #32, #19, #42
    • Contributed to forum discussions (example: #121)
    • Reported bugs and suggestions for other teams in the class (example: 1)
  • Tools:
    • Updated Gradle from 5.2.1 to 6.8.2 (example: 1).