Puah Siew Wen - Project Portfolio Page for traKCAL

Overview

• traKCAL is a desktop application for managing calorie intake, optimized for use via Command Line Interface (CLI) whilst retaining the benefits of a Graphical User Interface (GUI). traKCAL can manage your activities faster than traditional GUI applications.

Summary of Contributions

This section shows a brief overview of my contribution to traKCAL. It includes contributions like code writing, code documentation, UG/DG writing and other contributions for traKCAL.

Code contributed

• My code contributions can be found here

Enhancements implemented

• I implemented the add activity, edit activity, viewing help and chaining enhancements.

Here are some of their commands:

Words that look like THIS are parameters to be input by user Words that look like are optional parameters

• add f/ FOOD_DESCRIPTION c/ CALORIE_COUNT <d/ DATE> to add a new food activity.
• add e/ EXERCISE_DESCRIPTION c/ CALORIE_COUNT <d/ DATE> to add a new exercise activity.
• edit f/ FOOD_DESCRIPTION c/ CALORIE_COUNT to edit activity in list.
• edit f/ EXERCISE_DESCRIPTION c/ CALORIE_COUNT to edit activity in list.
• help to display the help list.

For chaining, examples of the usages are:

• add e/ EXERCISE_DESCRIPTION c/ CALORIE_COUNT <d/ DATE> && list && graph
• list && edit f/ FOOD_DESCRIPTION c/ CALORIE_COUNT && graph

Contributions to the User Guide

• I contributed to section 1 (viewing help), section 4 (adding), section 6 (editing), section 11 (chaining) and section 12 (exiting the program) in the user profile as well as command summary, overall formatting and proofreading of the User Guide.

Contributions to the Developer Guide

• I contributed to section 1 (introduction), section 3.2, 3.5, 3.7, section 4.3, 4.6, 4.7, section 5.1, 5.2, 5.3, 5.4, 5.5 (add, edit and chain)

Contributions to team-based tasks

• Updating user/developer docs that are not specific to a feature
• Updating of JavaDoc in the code

Review/mentoring contributions

• I reviewed 42 PRs from the team. The following are instances of the PRs I reviewed: instance 1 instance 2 instance 3

Contributions beyond the project team

Evidence of helping others e.g. responses you posted in our forum, bugs you reported in other team’s products, Evidence of technical leadership e.g. sharing useful information in the forum

• I helped test and identify bugs for other teams, the issues I raised can be found here.