Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.96 KB

barkhyehyeon.adoc

File metadata and controls

74 lines (50 loc) · 2.96 KB

Bark HyeHyeon - Project Portfolio

PROJECT: Souschef

Overview

Souschef is a desktop smart cooking sidekick, offering personalised guidance every step of the way. From recipe recommendations just for you, to meal planning and inventory management, SousChef has everything you need to improve life in the kitchen.

Our users interact via CLI and GUI created with JavaFX. Written in Java, experience what many are enjoying.

Summary of contributions

  • Code contributed: [Functional code]

  • Major enhancement: added the ability to manage ingredients

    • What it does: Allows the user to track the stock of ingredients, view recipe according to ingredient and check shop amount.

    • Justification: This is a practical feature which would enhance user experience of cooking preparation.

    • Highlights: Rather than mere stock tracking, this feature contains functions providing cognitive shortcut for users. Also, it enables proper integration between information related to ingredient and recipe.

  • Major enhancement: restructured entire logic component

    • Justification: This was necessary to enable integration across multiple features, while maintaining efficiency by distinguishing shared processes and making use of general classes.

    • Highlights: This enables both modularization and efficient integration of features.

    • PR#64

  • Other contributions:

    • General/Team Enhancements:

      • Implementation of universal commands (Pull requests #66)

      • Fix UI for desired view (Pull requests #151)

    • Community:

      • PRs reviewed (mainly related to logic component): #72, #77

      • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3, 4, 5)

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.

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.