Merge branch 'master' into inconsistencies-branch

Denise-Ng · Apr 9, 2020 · 3b2b5d6 · 3b2b5d6
2 parents f0a04b4 + 3320799
commit 3b2b5d6
Show file tree

Hide file tree

Showing 5 changed files with 92 additions and 4 deletions.
diff --git a/docs/AboutUs.adoc b/docs/AboutUs.adoc
@@ -32,7 +32,7 @@ Responsibilities: Usage and archive feature of Coupon Stash. Lead the team in th
 
 === Alden Tan
 image::alcen.png[width="150", align="left"]
-{empty}[http://github.com/alcen[github]] [<<johndoe#, portfolio>>]
+{empty}[http://github.com/alcen[github]] [<<alcen#, portfolio>>]
 
 Role: Developer +
 Responsibilities: "Saved" Feature in Coupon Stash to see how much you have saved

diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -779,6 +779,8 @@ Efficient.
 
 ** Cons: Harder to maintain two data files.
 Very prone to error.
+
+// tag::savings[]
 === Savings per use and total amount saved
 
 To allow users to keep track of how much they have saved
@@ -993,6 +995,8 @@ the Coupon to think in terms of an entire Savings
 object, rather than handle multiple different scenarios
 depending on which fields it has.
 
+// end::savings[]
+
 == Documentation
 
 Refer to the guide <<Documentation#, here>>.

diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -374,6 +374,7 @@ Uses the first coupon in the coupon stash, which also has a percentage savings.
 The total savings of the coupon will be calculated, and can be seen with the
 command `saved`.
 
+// tag::saved[]
 === Viewing savings: `saved`
 
 Shows you how much you have saved by using coupons in Coupon Stash.
@@ -418,7 +419,7 @@ on 1 March 2020.
 A message will be displayed: You have saved $117.15 as well as earned
 5x Brattby Bag, 7x Water Bottle, 12x Free Coffee, 1x Plush Toy
 between 1 May 2019 and 20 March 2020.
-
+// end::saved[]
 
 === Archiving a coupon: `archive`
 Archives a coupon when you want to keep a record of it, without cluttering your
@@ -703,7 +704,7 @@ Example:
 * `expand 1` +
 Open the coupon at index 1 in a new window.
 
-
+// tag::setpref[]
 === Setting user preferences: `setpref`
 Sets the user preferences in Coupon Stash. Available user
 preferences currently consist of:
@@ -713,6 +714,7 @@ preferences currently consist of:
 * More to be added in v2.0
 
 Format: `setpref [ms/NEW_MONEY_SYMBOL]`
+// end::setpref[]
 
 ****
 * At least one of the optional fields must be provided.

diff --git a/docs/team/alcen.adoc b/docs/team/alcen.adoc
@@ -0,0 +1,82 @@
+= Alden - Project Portfolio
+:site-section: AboutUs
+:imagesDir: ../images
+:stylesDir: ../stylesheets
+
+== PROJECT: Coupon Stash
+
+'''
+
+image::Ui.png[width="600"]
+
+== Overview
+
+Coupon Stash is a desktop application for keeping track of your
+coupons, coupon usage, and coupon savings. Coupon Stash is written
+in Java, JavaFX and FXML, by a team of 5 committed individuals
+(including me). Featuring a command-line interface as well as
+UI elements like calendars and graphs, Coupon Stash is an amazing
+application and a prominent highlight of my abilities.
+
+== Summary of contributions
+
+In this section, I will provide a brief summary of my contributions
+to Coupon Stash, as well as to documents like the User Guide
+and Developer Guide.
+
+* *Major enhancement*: The *savings* feature allowing users to
+keep track of how much they have saved from using coupons
+
+** Tracking savings per usage allows the user see how much they have
+saved, over the course of a certain time period.
+** This feature improves the product significantly because a key part
+of coupons is the savings and benefits it brings to the user, and so
+there is demand for knowing how much benefits you have reaped
+easily.
+** This feature was not easy to add as it required consideration
+about the various forms of savings that coupons may offer, such
+as a percent off the original price, a flat monetary amount, or
+even free gifts. Also, it required integration with other
+features, like the "used" feature which allows users
+to mark their coupons whenever they use them.
+
+* *Minor enhancement*: added a "setcurrency" command so users
+can customise the application to different regions, which
+would be helpful for exchange students for example.
+
+* *Code contributed*: View alcen's contributions with RepoSense
+https://nus-cs2103-ay1920s2.github.io/tp-dashboard/#=undefined&search=alcen[here]
+
+* *Other contributions*:
+
+** Project management:
+*** Managed releases `v1.2.5` - `v1.3.1` (3 releases) on GitHub
+** Enhancements to existing features:
+*** Updated the GUI with a savings graph and tab
+(Pull request https://github.com/AY1920S2-CS2103T-F09-1/main/pull/212[#212])
+*** Wrote additional tests for savings features to increase coverage
+(Pull requests https://github.com/AY1920S2-CS2103T-F09-1/main/pull/327[#327])
+** Tools:
+*** Integrated Github plugins (Travis CI, AppVeyor) to the team repo
+
+== Contributions to the User Guide
+
+
+|===
+|Here are some sections of the User Guide authored by me.
+|===
+
+include::../UserGuide.adoc[tag=saved]
+
+include::../UserGuide.adoc[tag=setpref]
+
+== Contributions to the Developer Guide
+
+|===
+|_These are some sections I contributed to the Developer Guide.
+Highlights include frequent use of Unified Modelling Language
+(UML) diagrams to illustrate associations between program components._
+|===
+
+include::../DeveloperGuide.adoc[tag=savings]
+
diff --git a/docs/team/nelsontky.adoc b/docs/team/nelsontky.adoc
@@ -33,7 +33,7 @@ feature that needed frequent updates.
 * *Minor enhancement*: added a history command that allows the user to navigate
 to previous commands using up/down keys.
 
-* *Code contributed*: [https://nus-cs2103-ay1920s2.github.io/tp-dashboard/#search=&sort=groupTitle&sortWithin=title&since=2020-02-14&timeframe=commit&mergegroup=false&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=authorship&tabAuthor=nelsontky&tabRepo=AY1920S2-CS2103T-F09-1%2Fmain%5Bmaster%5D[All contributed code]]
+* *Code contributed*: [https://nus-cs2103-ay1920s2.github.io/tp-dashboard/#=undefined&search=nelsontky[All contributed code]]
 
 * *Other contributions*: