Merge branch 'master' of https://github.com/AY2324S1-CS2103T-W16-1/tp …

…into modify-ppp
AY2324S1-CS2103T-W16-1 · Nov 13, 2023 · 8a7a720 · 8a7a720
2 parents cc707a3 + 39e230e
commit 8a7a720
Show file tree

Hide file tree

Showing 11 changed files with 343 additions and 110 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -129,12 +129,12 @@ Successful output:
 
 ### Listing [contacts](#contact): `list contact`
 
-Shows a list of all contacts in the contact list if tags not specified. 
-Otherwise, shows a list of contacts which contains any one of the specified tags. 
+Shows a list of all contacts in the contact list if tags not specified.
+Otherwise, shows a list of contacts which contains any one of the specified tags.
 
 Format: `list contact [-t TAGNAME...]`
 
-* Lists all contacts if no tags passed. 
+* Lists all contacts if no tags passed.
 * If tags argument passed, lists only contacts that contain one of the tags.
 
 Examples:

diff --git a/docs/diagrams/event/AddEventActivityDiagram.puml b/docs/diagrams/event/AddEventActivityDiagram.puml
@@ -0,0 +1,23 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+start
+:User executes add event command;
+
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+if () then ([person exists])
+    if () then ([no duplicates or clashes])
+        :Add a new event to the person in the address book;
+        :Returns result message with
+        the event that has been added;
+    else ([else])
+        :Throw CommandException;
+    endif
+else ([else])
+    :Throw CommandException;
+endif
+stop
+@enduml
diff --git a/docs/diagrams/event/DeleteEventActivityDiagram.puml b/docs/diagrams/event/DeleteEventActivityDiagram.puml
@@ -0,0 +1,24 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+start
+:User executes delete event command;
+
+'Since the beta syntax does not support placing the condition outside the
+'diamond we place it as the true branch instead.
+
+if () then ([person exists])
+    if () then ([event exists])
+        :Delete event from the person
+        in the address book;
+        :Returns result message with
+        the event that has been deleted;
+    else ([else])
+        :Throw CommandException;
+    endif
+else ([else])
+    :Throw CommandException;
+endif
+stop
+@enduml
diff --git a/docs/diagrams/event/EventSequenceDiagram.puml b/docs/diagrams/event/EventSequenceDiagram.puml
@@ -0,0 +1,87 @@
+@startuml
+!include ../style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":AddCommandParser" as AddCommandParser LOGIC_COLOR
+participant ":AddEventCommandParser" as AddEventCommandParser LOGIC_COLOR
+participant ":AddEventCommand" as AddEventCommand LOGIC_COLOR
+participant "commandResult:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute(commandText)
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand(commandText)
+activate AddressBookParser
+
+create AddCommandParser
+AddressBookParser -> AddCommandParser
+activate AddCommandParser
+
+AddCommandParser --> AddressBookParser
+deactivate AddCommandParser
+
+AddressBookParser -> AddCommandParser : parse(commandText)
+activate AddCommandParser
+
+create AddEventCommandParser
+AddCommandParser -> AddEventCommandParser
+activate AddEventCommandParser
+
+AddEventCommandParser -> AddCommandParser
+deactivate AddEventCommandParser
+
+AddCommandParser -> AddEventCommandParser : parse(commandText)
+activate AddEventCommandParser
+
+create AddEventCommand
+AddEventCommandParser -> AddEventCommand
+activate AddEventCommand
+
+AddEventCommand --> AddEventCommandParser
+deactivate AddEventCommand
+
+AddEventCommandParser --> AddCommandParser
+deactivate AddEventCommandParser
+AddEventCommandParser -[hidden]-> AddCommandParser
+destroy AddEventCommandParser
+
+AddCommandParser --> AddressBookParser
+deactivate AddCommandParser
+AddCommandParser -[hidden]-> AddressBookParser
+destroy AddCommandParser
+
+AddressBookParser --> LogicManager
+deactivate AddressBookParser
+
+LogicManager -> AddEventCommand : execute()
+activate AddEventCommand
+
+AddEventCommand -> Model: findPersonByUserFriendlyId(contactId)
+activate Model
+
+Model -> AddEventCommand: person
+deactivate Model
+
+create CommandResult
+AddEventCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> AddEventCommand : commandResult
+deactivate CommandResult
+
+AddEventCommand --> LogicManager : commandResult
+deactivate AddEventCommand
+AddEventCommand -[hidden]-> LogicManager
+destroy AddEventCommand
+
+[<--LogicManager : commandResult
+deactivate LogicManager
+@enduml
diff --git a/docs/images/zekone.png b/docs/images/zekone.png
diff --git a/docs/team/andrewjanong.md b/docs/team/andrewjanong.md
@@ -11,7 +11,7 @@ KeepInTouch is a desktop app for managing contacts for people in the working ind
   * What it does: It allows users to find contacts containing certain tags.
   * Justification: This feature improves the product efficiency as the user may now search through contacts more effectively.
 
-* **Existing Feature**: 
+* **Existing Feature**:
 
 * **Code contributed**: Code contribution can be found [here](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=&sort=totalCommits&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByNone&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&tabAuthor=AndrewJanong&tabRepo=AY2324S1-CS2103T-W16-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
 

diff --git a/docs/team/josepholim.md b/docs/team/josepholim.md
@@ -10,20 +10,37 @@ KeepInTouch is a desktop app for managing contacts for people in the working ind
 * **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=josepholim&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&tabAuthor=josepholim&tabRepo=AY2324S1-CS2103T-W16-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
 
 * **Enhancements implemented**:
-    * Added `add note` commands and tests.
+    * Added `add note` commands and tests. ([\#39](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/39), [\#42](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/42))
         * What it does: Supports adding a note to a contact.
-    * Added `delete note` commands and tests.
+        * Justification: This feature allows the user to record additional information about each contact.
+    * Added `delete note` commands and tests. ([\#39](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/39), [\#42](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/42))
         * What it does: Supports deleting a note from a contact.
-    * Added support for duplicate contact names.
+        * Justification: This feature allows the user to remove additional information that are no longer relevant.
+    * Added support for duplicate contact names. ([\#72](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/72))
+        * Previously in AB3, two contacts are considered duplicates if they have the same name. I modified the definition of duplicate contacts to those with the same names and data fields.
+        * Justification: This feature allows the user to have multiple contacts with the same name.
+    * Fixed bug for empty fields in `add note` and `delete note` commands. ([\#60](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/60))
+        * Justification: Added regex validation to ensure that the fields for the commands cannot be an empty string or a string with only whitespaces.
+    * Increased coverage by adding tests. ([\#42](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/42), [\#183](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/183))
+        * Justification: Coverage increased by 1% and 2% in each PR.
 
 * **Documentation**:
     * User Guide:
-        * to be added soon
+        * Adapt the UG for add note and delete note by id ([\#39](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/39))
+        * Modify the UG for list events feature ([\#158](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/158))
+        * Fix Table of Content ([\#156](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/156))
+        * Fix typos and formatting ([\#177](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/177))
     * Developer Guide:
-        * to be added soon
+        * Added Table of Content ([\#192](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/192))
+        * Added Implementation for Notes Feature ([\#182](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/182))
+        * Added User Stories ([\#52](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/52), [\#179](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/179))
+        * Added Use Cases ([\#25](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/25), [\#52](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/52), [\#179](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/179))
+        * Added Non-Functional Requirements ([\#12](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/12), [\#180](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/180))
+        * Added Instructions for Manual Testing for Notes feature ([\#193](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/193))
 
-* **Community**:
-    * to be added soon
+* **Review/Mentoring contributions**:
+    * Reviewed a total of 22 PRs.
+    * Answering queries from team members in the Telegram group chat.
 
-* **Tools**:
-    * to be added soon
+* **Contributions beyond the project team**:
+    * Reported 21 bugs for the other team during the PED.
diff --git a/docs/team/larrywang0701.md b/docs/team/larrywang0701.md
@@ -18,7 +18,7 @@
           - Filter and sort events [#71](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/71)
           - Relevant test cases for event feature [#33](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/33) [#71](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/71) [#169](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/169)
           - Bug fixes for event feature [#47](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/47) [#85](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/85)
-  
+
   - #### Enhancements implemented
     - Enhanced the logic of command parser to support secondary command word [#33](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/33)
 

diff --git a/docs/team/nixx162.md b/docs/team/nixx162.md
@@ -9,10 +9,10 @@ KeepInTouch is a desktop app for managing contacts for people in the working ind
 
 Given below are my contributions to the team:
 
-* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=nixx162&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22) 
+* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=nixx162&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22)
 
 * **Project management**:
-    * Went through all the issues in GitHub to create a summary of what bugs there are (eliminating duplicate reports), whether they can be fixed, and recommended ideas of fixing it.  
+    * Went through all the issues in GitHub to create a summary of what bugs there are (eliminating duplicate reports), whether they can be fixed, and recommended ideas of fixing it.
 
 * **Enhancements to existing features**:
     * Improved help feature to better accomodate users. The old help command only opens a window containing a link to the user guide. The improvements I implemented are:

diff --git a/docs/team/zekone.md b/docs/team/zekone.md
@@ -21,7 +21,7 @@ KeepInTouch is a desktop app for managing contacts for job-seekers. It can also
   * Managed `1.3.trial` release.
   * Created 12 labels for better tracking of issues.
   * Created milestones `v1.2` and `v1.3`.
- 
+
 * **Fixed bugs reported in PE-D**:
   * Added tag related help message to help command ([\#147](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/147))
   * Fixed help and error messages ([\#148](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/148), [\#155](https://github.com/AY2324S1-CS2103T-W16-1/tp/pull/155))