Project: AddressBook Level 3

to be added soon

AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. 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: Added the ability to undo/redo previous commands.
    • What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
    • 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: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
    • Credits: {mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}
  • New Feature: Added the ability to sort clients by name, emails and phones
    • What it does: allows the user to sort client lists
    • Justification: This feature improve the usability of the product because a user can make his client list to be ordered in the way he want

  • Code contributed: RepoSense link

  • Project management:
    • Managed releases v1.3 - v1.5rc (3 releases) on GitHub
  • Enhancements to existing features:
    • Updated the GUI color scheme (Pull requests #33, #34)
    • Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests #36, #38)
  • Documentation:
    • User Guide:
      • Added documentation for the features sortCommand #72
      • Did cosmetic tweaks to existing documentation of features undo, redo: #74
    • Developer Guide:
      • Added implementation details of the undo and redo feature.
      • Added implementation details of the sortCommand feature
  • Community:
    • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
    • Contributed to forum discussions (examples: 1, 2, 3, 4)
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
    • Some parts of the history feature I added was adopted by several other class mates (1, 2)
  • Tools:
    • Integrated a third party library (Natty) to the project (#42)
    • Integrated a new Github plugin (CircleCI) to the team repo
  • {you can add/remove categories in the list above}