tp

Overview

Kitchen Helper is a desktop application mainly targeted for home user who often have trouble tracking their ingredients in their kitchen. This application allows the user to keep track of their ingredient efficiently, regardless of buying new ingredients at a supermarket or cooking a meal at home. Moreover, the user interaction is mainly through command line interface(CLI), that brings convenience to user who prefers fast typing.

Contribution Summary

• Role: Developer

• Responsibility: Code Quality

• Major enhancement:
  • List Ingredient
    • Functionality: Allows user to view Ingredients added by the user, in an orderly and sorted manner.
    • Justification: This feature improves the product significantly because by having a better view of the situation, users can view their ingredients with ease.
    • Highlights: User will have a better view of the situation of their stockpile and allows better control over their ingredients.
  • List Recipe
    • Functionality: With this enhancement, it allows user to list down all recipe names the user created and view the ingredients needed for the recipe.
    • Justification: This feature allows user to have a better view of the recipes added and allows access to the recipe’s ingredient information.
    • Highlights: User can easily find out what ingredient is needed for the recipe added by them.
  • Notification Warning for Ingredients
    • Functionality: With this enhancement, it allows user to know immediately whether their ingredient is expiring in 3 days, expired or low quantity (< 5).
    • Justification: This feature allows user know which ingredients is at a bad state or which ingredients needs to be restocked.
    • Highlights: User can easily find out which ingredients is expiring, expired or low quantity.

• Code contribution: Functional and Test code

• Other contributions:
  • Code Quality:
    • Recommends and advises how features could be coded and ensures code quality.
  • Community:
    • Review Pull Request from teammates(with non-trival review comments.)
    • Played a part in giving suggestions and providing views, such as Pros and Cons, from different angle for various ideas in the initial planning stage.
    • Reported bugs for other teams in the class.
    • Perform manual testing, reported bugs, gave suggestions to teammates and corrects misdirections of teammates.

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.

• List Ingredient

• List 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.

• List all/ specific ingredient(s)

• List all/ specific recipe(s)

• Notification for ingredients warning

• Part of Use cases in Appendix C

• Instructions for Manual Testing in Appendix F (Example: 1 , 2)