Lim Yan Ting Project Portfolio

Overview - Kitchen Helper

Kitchen Helper is a command line interface (CLI) application that is mainly targeted for household users who have difficulty in remembering what they have in their kitchen. This application aids them in the tracking of ingredients that are currently in their kitchen more efficiently.

Contributions

• Responsibility: Issue Tracker

Enhancements implemented

• Deletion of ingredients and recipes
  • What it does: It allows the user to delete any ingredient or recipe with regards to the list of ingredients or recipes in Kitchen Helper respectively.
  • Justification: This feature improves the product slightly because a user may make a mistake and input the wrong parameters for an ingredient or a recipe. With this feature, the user will be able to delete this wrongly keyed ingredient or recipe.
  • Highlights: This enhancement was done by deleting the ingredient based on their index so that the users can delete a specific ingredient that they want. However, for deletion of recipe, there is an additional enhancement of deletion by name as the recipe names are unique so the users can delete a specific recipe by deleting through the names.
• Deduction of quantity of ingredients
  • What it does: It allows the user to reduce the quantity of an ingredient.
  • Justification: This feature improves the product slightly because a user may just want to utilize a few quantities of the ingredient without cooking the recipe. Example, if a user wants to just eat an apple, the user can use this feature to deduct the quantity of apple by 1.
  • Highlights: This enhancement deletes the ingredient automatically if the final quantity after the deduction is zero for the ingredient.
• Added the deduction of ingredients from list of ingredients after a user has cooked a recipe
  • What it does: It automatically deducts the ingredients found in the recipe that the user has specified to cook if there are enough and non-expiring ingredients in the list of ingredients.
  • Justification: This feature improves the product slightly because a user does not have to manually deduct the quantity of ingredients which increases convenience for the users in managing their ingredients’ inventory.
  • Highlights: Similar to Deduction of quantity of ingredients

Code Contributions

The link below showed my code contributions to Kitchen Helper:

Functional and Testing Code

Other Contributions

• Project Management:
  • Managed the Issue Tracker and Milestones by creating and closing unnecessary issues to track the members’ progress for Kitchen Helper with respect to User Stories and bugs
  • Helped to merge and review PR to maintain the repository
• Documentation:
  • Added the architecture diagram and use cases of above implementation in Developer Guide
  • Added the documentation for DeleteIngredientCommand, DeleteRecipeCommand and CookRecipeCommand for both User Guide and Developer Guide
  • Added the introduction and scope in Developer Guide
• Community
  • PR reviewed (with non-trivial review comments): #38, #93, #109, #123, #152, #226, #227, #240, #242, #253, #285
  • Reported bugs and suggestions for other teams in class (examples: #1, #2, #3, #4, #5, #6, #7, #8, #9)
  • Did some testing and found bugs in teammates’ codes

Documentation

Contributions to the User Guide

Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users.

• Delete Ingredient
• Delete Recipe
• Cook Recipe

Contributions to the Developer Guide

Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.

• Architecture
• Delete Ingredient
• Delete Recipe
• Cook Recipe
• Instructions for Manual Testing: #Delete Ingredient, #Delete Recipe