forked from nus-cs2103-AY1718S2/addressbook-level4
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #115 from wenhao53/Enhancements
Updated PPP, UGDG
- Loading branch information
Showing
3 changed files
with
64 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
= Cheng Wenhao - Project Portfolio | ||
:imagesDir: ../images | ||
:stylesDir: ../stylesheets | ||
|
||
== PROJECT: Personal Trainer Pro Application | ||
|
||
--- | ||
|
||
== Overview | ||
|
||
Personal Trainer Pro is a desktop application used by personal trainers and their clients to keep track of their fitness journey. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. | ||
|
||
== Summary of contributions | ||
|
||
* *Major enhancement*: changed *background colour for person to be attribute-dependent* | ||
** What it does: Each time the weight or height of a person is changed, the Body Mass Index of that person is automatically recalculated. | ||
These changes will affect the classification of the Body Mass Index of the given person. The classification of the BMI (Underweight, Acceptable, Overweight, Obese) | ||
is then reflected more intuitively as the background colour of the PersonCard to reduce the cluttering of information displayed on the card. | ||
** Justification: At times, personal trainers want to design a set of workout tailored for a group of people and more often than not, workouts are tailored based on the client's BMI. | ||
Allowing the personal trainer to know at a quick glance how many of his clients fall under which BMI classification would allow the trainer to better gauge what kind of workouts is needed. | ||
** Highlights: the background colour of the PersonCard is changed immediately upon any changes to the BMI classification with each edit command. | ||
|
||
* *Minor enhancement*: added a *filtering command to sieve of clients of the same BMI classification* that complements the justification above | ||
* *Minor enhancement*: added a height and BMI attribute to facilitate the classification of clients according to BMI.(Pull requests https://github.com/CS2103JAN2018-F12-B2/main/pull/27/[#27], https://github.com/CS2103JAN2018-F12-B2/main/pull/38/[#38]) | ||
|
||
* *Code contributed*: [https://github.com/CS2103JAN2018-F12-B2/main/src/master/collated/functional/wenhao53.md[Functional code]] [https://github.com/CS2103JAN2018-F12-B2/main/src/master/collated/test/wenhao53.md[Test code]] | ||
|
||
* *Future implementations*: To make use of Google Charts API to provide an interactive display in Weight Logging for each client. | ||
* *Other contributions*: | ||
|
||
** Project management: | ||
*** Written all enhancements and ensured that code complies to coding standards, resulting in minimal (< 0.5%)drop in code coverage with each PR. | ||
** Enhancements to existing features: | ||
*** Implemented case-insensitivity for AddCommand to allow leniency with alphabetical case errors. (Pull request https://github.com/CS2103JAN2018-F12-B2/main/pull/15/[#15]) | ||
*** Restricted Height and Weight input to a specified range to prevent overflow issues and display problems. | ||
** Documentation: | ||
*** Served as the main link and auditor for documentation to ensure consistencies in display, format and representation. (Pull requests https://github.com/CS2103JAN2018-F12-B2/main/pull/24/[#24], https://github.com/CS2103JAN2018-F12-B2/main/pull/45/[#45], https://github.com/CS2103JAN2018-F12-B2/main/pull/57/[#57]) | ||
*** Updated user stories and use cases in accordance with inital projections of project implementations. (Pull request https://github.com/CS2103JAN2018-F12-B2/main/pull/20/[#20]) | ||
** Community: | ||
*** Helped to solve test failures in the early stages of the project by pinpointing missing implementations and person tests. | ||
*** Reported bugs and suggestions for other teams in the class during user testing (examples: https://github.com/CS2103JAN2018-F09-B2/main/issues/114) | ||
|
||
|
||
== 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._ | ||
|=== | ||
|
||
include::../UserGuide.adoc[tag=filter] | ||
|
||
== 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._ | ||
|=== | ||
|
||
include::../DeveloperGuide.adoc[tag=bmiclassification] | ||
|
||
--- |