Ryan Kwok - Project Portfolio Page

This is a student project for university software development course and I am one of the contributors to the FridgeFriend project.

Summary of Contributions

Given below are my contributions to the project

New Features

• Added the ability to display a help message
  • What it does: Provides the user with a list of available commands and formats.
  • Justification: Allows the user the ease of using commands without having to memorise them.
  • Pull request: (#49)
• Added the ability to search for items that are expiring
  • What it does: Allows the user to get a list of all food items that are going to expire in a week.
  • Justification: Improves the product signicantly because a user can effectively track the status of all food items in the fridge with a single command.
  • Pull request: (#66)
• Added a warning feature for food that is running low
  • What it does: Sends the user a warning if a removal of a food item brings the total food quanitity of that category below a specified limit.
  • Justification: Allows the user to better track the relative quantity of food in the fridge.
  • Pull request: (#112)
• Added the ability to list all food categories that are running low
  • What it does: Provides the user with a list of food categories that have food quanities below the specified limit
  • Justification: Allows the user to easily create a shopping list of items based on food categories
  • Pull request: (#114)
• Added the ability for users to specify the minimum quantity of food for each category
  • What it does: Allows the user to modify the lower quantity limit for each category
  • Justification: Allows for personalisation of fridge, since different users have differing requirements and preferences for the quantity of each food category
  • Pull request: (#115)
• Code contributed: more than 2000 lines of code (RepoSense)

Enhancements to Existing Features

• Wrote and refactored major classes (#44)
  • Fridge, Parser, Ui, ByeCommand, InvalidIndexException, and InvalidInputException
• Wrote additional tests for Parser class (#47)
• Wrote Logger class (#51)
• Wrote logging for FridgeFriend (#52)
• Improve Coding Standards for Storage class (#68)

Documentation

• User Guide
  • Added introduction (#75)
  • Added documentation for the feature expiring (#69)
  • Added documentation for the features remove, help, and bye (#75)
  • Standardised input/output format for existing documentation of all features (#75)
  • Added documentation for the features runninglow and setlimit (#106)
  • Fixed bugs (#204, #215)
• Developer Guide
  • Added implementation details of the Utilities component (#106)
    • Utilities Class Diagram
  • Added implementation details of the main application logic (#134)
    • Main Logic Sequence Diagram
  • Added User Stories (#134)
  • Added a contents list (#134)
  • Adjusted diagram sizes (#134, #215)
  • Fixed bugs (#204, #215)
  • Applied cosmetic changes to improve readability (#215)
• README.md
  • Wrote all project details and contents (#134)

Community

• Pull Requests reviewed with non-trivial review comments (#38, #54, #56 #61, #93, #94, #108, #110, #119, #131, #140, #202 #207)
• Contributed to forum discussions (1, 2, 3, 4, 5)
• Reported bugs and suggestions for other teams in the class (1 2 3 4 5 6)