Project: Pawbook

Pawbook is a desktop application for dog school managers to facilitate their bookkeeping of puppies and dogs in the school, optimized for use via a Command Line Interface (CLI) which caters to fast-typers who prefer to use a keyboard. You can navigate the application with ease and execute instructions by typing text-based commands in the command box provided.

Given below are my contributions to the project.

  • New Feature: View Command
    • Implemented the View Command that allows users to view all the related entities of one particular entity.
    • In the process, I had to build ViewCommandParser, ViewCommandComparator and IdMatchPredicate to allow the proper functioning of this command.
  • New Feature: Find Command
    • Re-enabled the Find Command after the initial disabling during the refactoring stage of the initial code base.
    • Refactored the Find Command to work with our implementation of the three entities of dog, owner and program.
    • Allowed partial matching of Find Command in keywords.
  • Code Refactoring: Change the result display order for all commands.
    • Refactored the ordering of the way the results are displayed in the for all commands.
    • In the process, built IdMatchPredicate to assist in the way the entities are displayed on the main list display.
    • Built the sortEntities model method to support the result display ordering.
  • Code Refactoring: Removed all references to AB3-AddressBook.
    • Removed project-wide references and usage of variables linked to AddressBook and changed it to Database to fit with our project instead.
    • Fixed all related test cases that started failing after the major refactoring.
  • Code Refactoring: Code Quality Improvements
    • Increase defensive coding, exceptions and assertions.
    • Removed unnecessary assertions and improved Javadoc comments.
    • General housekeeping of code quality during development.
  • Code Testing: Writing test cases
    • Wrote test cases for ViewCommand, ViewCommandParser, FindCommand, FindCommandParser, ScheduleCommand, ScheduleCommandParser, EditDogCommand
    • Increased code coverage by 7%.

  • Code contributed: RepoSense link

  • Project management:
    • Managed milestones v1.2 - v1.4 on GitHub
    • Assigned and allocated issues to team members for smoother work allocation.
    • Organised weekly meetings whenever needed.
  • Enhancements to existing features: GUI Refactoring
    • Refactored the look and feel of the UI, such as through re-arrangement of the JavaFX components and layering.
    • Included the ID field and logo for different entities.
  • Documentation:
    • User Guide:
      • Wrote Introduction, Purpose, Syntax, GUI Layout, Find Command, View Command, Command Summary and Glossary.
      • Streamlined and cleaned up the User Guide frequently to match current implementations of Pawbook.
    • Developer Guide:
      • Wrote Introduction, Purpose, Target User, Value Proposition, Use Cases, NFRs, User Stories, Find Command, View Command, Manual Testing and Effort.
      • Completed Find Command, View Command and their respective sequence diagrams and activity diagrams, as well as their respective descriptions and explanations.
      • Cleaned up DeveloperGuide to ensure consistency before submission.
  • Community:
    • Reviewed pull requests of other contributors frequently.
    • Provide feedback to peers on their pull requests.
    • Reported bugs and suggestions to other teams in class.