diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 61cbe59d95e..bf26e7b2f1b 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -9,7 +9,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` ## Project team -### Thomas Ho +### Ho Lok Wah diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 75c654dc4bf..cca01f6d6ac 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -856,13 +856,13 @@ In all commands `INDEX` **must be a positive integer** 1, 2, 3, …​ In [`editClient`](#715-edit-client-editclient), [`delClient`](#714-delete-client-delclient), and [`viewClient`](#713-view-client-viewclient) commands, `INDEX` refers to the number shown by executing [`listClient`](#712-list-clients-listclient) command. -e.g. David Li has position of 4 in the shown [client list](#712-list-clients-listclient) +e.g. David Li has position of 4 in the shown [client list](#712-list-clients-listclient): ![](images/ListClient.png) In [`viewMeeting`](#723-view-meeting-viewmeeting), [`delMeeting`](#724-delete-meeting-delmeeting), and [`editMeeting`](#725-edit-meeting-editmeeting) commands, `INDEX` refers to the number shown by executing [`listMeeting`](#722-list-meetings-listmeeting) command. -e.g. The meeting shown has position of 1 in [meeting list](#722-list-meetings-listmeeting) +e.g. The meeting shown has position of 1 in [meeting list](#722-list-meetings-listmeeting): ![](images/ListMeeting.png) In [`delProduct`](#733-delete-product-delproduct) command, `INDEX` refers to the number shown by executing [`listProduct`](#732-list-products-listproduct) command. diff --git a/docs/images/ListClient.png b/docs/images/ListClient.png new file mode 100644 index 00000000000..dc4418b0f8e Binary files /dev/null and b/docs/images/ListClient.png differ diff --git a/docs/images/ListMeeting.png b/docs/images/ListMeeting.png new file mode 100644 index 00000000000..5cc407bf0d1 Binary files /dev/null and b/docs/images/ListMeeting.png differ diff --git a/docs/images/ListProduct.png b/docs/images/ListProduct.png new file mode 100644 index 00000000000..e276059320d Binary files /dev/null and b/docs/images/ListProduct.png differ diff --git a/docs/team/junweimoo.md b/docs/team/junweimoo.md index c36cf58121b..3282579c64d 100644 --- a/docs/team/junweimoo.md +++ b/docs/team/junweimoo.md @@ -15,36 +15,41 @@ Given below are my contributions to the project. * [RepoSense link](https://nus-cs2103-ay2223s1.github.io/tp-dashboard/?search=w16-4&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2022-09-16&tabOpen=true&zFR=false&tabType=authorship&tabAuthor=junweimoo&tabRepo=AY2223S1-CS2103T-W16-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) * **Enhancements implemented**: - * Command enhancements [#127](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/127), [#183](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/183) + * Command enhancements [#127](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/127), [#183](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/183): * Added command to filter meetings by time period with associated tests. * Added command to add a new meeting with associated tests. * Improved handling of invalid inputs by displaying more specific messages. * Developing the addMeeting command involved deliberate consideration of several implementation methods, because meetings and clients has a two-way object reference. At the same time, the model and storage had to be revamped to handle checks for conflicting meeting times. The command can be considered to be complete as it performs as intended, has checks for invalid and conflicting inputs, and has associated automated tests. + * GUI enhancements [#113](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/113), [#195](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/195) * Added ability to switch between various GUI panels for different commands. * Added panels for a detailed view of meeting and client information. * Modified list view to better suit the needs of financial advisors. * Added ability to switch between light and dark themes. * The GUI was made to present condensed information in list format, and detailed information in the view of singular clients and meetings. New fxml files and associated controller classes had to be implemented in order to display the information to suit the needs of financial advisors. The enhancements to the UI can be considered complete as it matches follows the GUI mockup our team created at the start of the project. + * Storage enhancements [#107](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/107), [#311](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/311), [#324](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/324) * Enhanced existing storage code to store meetings and products in addition to clients. * Added more tests to check error handling in case of invalid data. * Storage classes were updated to store the additional lists of meetings and clients. At the same time, recovering the objects from the json file involved deliberation over the implementation of the two-way object reference between clients and meetings. The enhancements to the storage can be considered complete as the program data can be stored and recovered from a json file. + * Model enhancements [#298](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/298), [#149](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/149) * Added new methods for meetings and clients to support command operations. * Added field validation regexes for validating input strings. * Fixed bugs for conflicting meeting times - * Checks against conflicting meeting times were implemented in the model. The editMeeting command also had to be guarded against bugs so as to prevent the meeting being edited from "conflicting" with the existing meeting. - + * Checks against conflicting meeting times were implemented in the model. The editMeeting command also had to be guarded against bugs to prevent the meeting being edited from conflicting with the existing meeting. + * **Documentation**: * User Guide [#286](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/286) * Wrote documentation for commands. * Wrote introduction. * Edited documentation and added navigation links. - * Developer Guide [#323](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/323) + + * Developer Guide [#323](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/323), [#348](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/348), [#74](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/74) * Described the implementation of addMeeting with accompanying sequence diagram. * Explained the choices made when deciding between implementations. * Wrote use cases for MyInsuRec. + * Added non-function requirements. * **Team-Based Tasks**: * Renamed the product to MyInsuRec and suggested ways to morph the feature set. diff --git a/docs/team/thomashoooo.md b/docs/team/thomashoooo.md index b48a8dbe098..57b80195a05 100644 --- a/docs/team/thomashoooo.md +++ b/docs/team/thomashoooo.md @@ -1,6 +1,6 @@ --- layout: page -title: Thomas Ho's Project Portfolio Page +title: Ho Lok Wah's Project Portfolio Page --- ### Project: MyInsuRec @@ -12,21 +12,18 @@ optimized for use via a Command Line Interface (CLI), with all the benefits of a Given below are my contributions to the project. * **New Feature**: Added the ability to view a client's details - * What it does: Users can view more details regarding the client such as the client's birthday and meetings associated with the client instead of just an overview. - * Justification: It is a core feature for financial advisors to manage their contacts and record down clients' particulars. + * Justification: A new command to view client's details is added. New classes and test cases also have to be implemented to ensure that the command doesn't fail. It also has to return the correct client's details when the user enters a filter to the client list. * **New Feature**: Added the ability to view a meeting's details - * What it does: Users can view more details regarding the meeting such as the meeting's schedule and the client's details whom the user is meeting with. - * Justification: It is a core feature for financial advisors to help plan their schedules and better prepare for the meeting. + * Justification: A new command to view meeting's details is added. New classes and test cases also have to be implemented to ensure that the command doesn't fail. It also has to return the correct meeting's details when the user enters a filter to the meeting list. * **Enhancements to existing features**: Added the ability for users to tag a product to a client - * Justification: It helps the financial advisor record down the products which the client has bought. It aims to improve the user's experience so that the user can have more information about the client. + * Justification: This implementation is challenging as it requires a new model of `Product` to be added and new testcases have to be added as well. * **Enhancements to existing features**: Added the ability for users to filter clients based on the products they bought - * Justification: Financial advisors can now have an overview of the clients who bought a specific type of product. If a product's policy has changed, the financial advisor can immediately know who is affected. Furthermore, it also helps the financial advisor to perform analysis on which product is the most popular. * **Enhancements to existing features**: Added the ability for user to specify the ending time for a meeting - * Justification: Financial advisors can specify the **exact** duration for the meeting to ensure that meetings won't be overlapping. Previously we didn't have an ending time which is problematic because the financial advisor can enter 2 meetings that are 1 minute away from each other which doesn't make sense in the real life situation. + * Justification: Due to the newly added ending time for a meeting, it requires more checks on the time period for meetings to see whether those meetings clash and it requires more changes to other commands that involve meetings as well. * **Project management**: * Assigned tasks and bugs to group members to ensure that project's objectives are met @@ -40,16 +37,17 @@ Given below are my contributions to the project. * Added documentation for `listClient`, `addProduct`, `viewClient`, `viewMeeting`: [#196](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/196), [#284](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/284) * Added hyperlinks to improve navigability: [#203](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/203) * Developer Guide: - * Added documentation for `viewMeeting`: [#181](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/181) + * Added documentation for `viewMeeting`, `viewClient` and `addProduct`: [#330](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/330) * **Community**: * Contributed to forum discussions : [#121](https://github.com/nus-cs2103-AY2223S1/forum/issues/121#issuecomment-1235101343), [#42](https://github.com/nus-cs2103-AY2223S1/forum/issues/42#issuecomment-1221382154) * Reported a bug on the official CS2103T website [#143](https://github.com/se-edu/addressbook-level3/issues/143) - * PRs reviewed outside of team (with non-trivial review comments) to improve code quality: [#258](https://github.com/nus-cs2103-AY2223S1/ip/pull/258), [#83](https://github.com/nus-cs2103-AY2223S1/ip/pull/83) - * PRs reviewed within the team (with non-trivial review comments): [#177](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/177), [#178](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/178), [#183](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/183), [#186](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/168), + * PRs reviewed within the team (with non-trivial review comments): [#304](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/304), [#178](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/178), [#183](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/183), [#270](https://github.com/AY2223S1-CS2103T-W16-4/tp/pull/270), -* **Tools**: +* **Team tasks**: + * Set up the Github team organisation and repository * Integrated Codecov into the team repo * Set up Github pages for Jekyll + * Maintain the issue tracker * **Code contributed**: [RepoSense link](https://nus-cs2103-ay2223s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2022-09-16&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=ThomasHoooo&tabRepo=AY2223S1-CS2103T-W16-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)