From 11946e01245cb0a8670d184f34847cbd8f8b91c4 Mon Sep 17 00:00:00 2001 From: josepholim Date: Fri, 27 Oct 2023 13:26:12 +0800 Subject: [PATCH 1/4] Enable Assertions in build.gradle --- build.gradle | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/build.gradle b/build.gradle index a2951cc709e..98c44b0dc9b 100644 --- a/build.gradle +++ b/build.gradle @@ -20,6 +20,10 @@ checkstyle { toolVersion = '10.2' } +run { + enableAssertions = true +} + test { useJUnitPlatform() finalizedBy jacocoTestReport From bed8b23dae9dbdd3731a8341a3f8a777a08f37c1 Mon Sep 17 00:00:00 2001 From: josepholim Date: Mon, 30 Oct 2023 04:21:41 +0800 Subject: [PATCH 2/4] add dg for notes --- docs/DeveloperGuide.md | 60 +++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 58220c1a226..9263b30833e 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1,7 +1,7 @@ --- layout: default.md - title: "Developer Guide" - pageNav: 3 + title: "Developer Guide" + pageNav: 3 --- # KeepInTouch Developer Guide @@ -168,11 +168,11 @@ This section describes some noteworthy details on how certain features are imple **Rationale** - * Previous help feature simply opens a page with a link to the website, this is bad because: +* Previous help feature simply opens a page with a link to the website, this is bad because: * The flow is lengthy * User may not be able to access website when operating without the internet - - Therefore, we want to make this better by simplifying the flow. We do this by adding: + + Therefore, we want to make this better by simplifying the flow. We do this by adding: * Making the help command return things in the application console * Letting users enter an extra argument to specify what command they need guiding on @@ -255,13 +255,13 @@ The following activity diagram summarizes what happens when a user executes a ne **Aspect: How undo & redo executes:** * **Alternative 1 (current choice):** Saves the entire address book. - * Pros: Easy to implement. - * Cons: May have performance issues in terms of memory usage. + * Pros: Easy to implement. + * Cons: May have performance issues in terms of memory usage. * **Alternative 2:** Individual command knows how to undo/redo by itself. - * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted). - * Cons: We must ensure that the implementation of each individual command are correct. + * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted). + * Cons: We must ensure that the implementation of each individual command are correct. _{more aspects and alternatives to be added}_ @@ -309,8 +309,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* * *` | user | delete a contact | remove a contact (by name) that I do not need | | `* * *` | user | view all contact | easily see and know what contacts are currently stored in the application in one place | | `* *` | user | view all notes | easily see and know what notes are currently stored in the application in one place | -| `* *` | user | add notes to a contact | record additional information about that contact in the notes | -| `* *` | user | delete notes to a contact | remove additional information that are no longer needed about that contact in the notes | +| `* *` | user | add notes to a contact | record additional information about that contact as notes | +| `* *` | user | delete notes to a contact | remove additional information about that contact that are no longer relevant | | `* *` | user who has some event to do | add an event | record an event with start time and also end time, location and any additional information like what to do during the event | | `* *` | user who has/had some event to do | delete an event | remove an event after it is obsolete, cancelled or no longer needed to be recorded | | `* *` | tidy user | tag a contact with a label | keep my contacts oraganised and categorised | @@ -412,7 +412,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli **MSS** 1. User requests to add a note to a contact. -2. KeepInTouch adds the note to the contact. +2. KeepInTouch adds a note to the contact. Use case ends. @@ -434,8 +434,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli **MSS** -1. User requests to delete a note from a contact. -2. KeepInTouch deletes the note from the contact. +1. User requests to delete an existing note from a contact. +2. KeepInTouch deletes the specified note from the contact. Use case ends. @@ -456,7 +456,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 1c. User inputs a note that does not exist. * 1c1. KeepInTouch shows a message indicating that the note cannot be found. - + Use case ends. **Use case: UC08 - Add an event** @@ -520,15 +520,15 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 1b1. Extra argument is a command word. - * KeepInTouch returns documentation on that command word. + * KeepInTouch returns documentation on that command word. * 1b2. Extra argument is not a command word, but is somewhat similar. - * KeepInTouch suggests the command word with the highest degree of similarity to the input + * KeepInTouch suggests the command word with the highest degree of similarity to the input * 1b3. Extra argument is not a command word, and isn't recognizably close to a command word. - * KeepInTouch lets the user know that it is unable to recognize the input. + * KeepInTouch lets the user know that it is unable to recognize the input. Use case ends. @@ -657,15 +657,15 @@ testers are expected to do more *exploratory* testing. 1. Initial launch - 1. Download the jar file and copy into an empty folder + 1. Download the jar file and copy into an empty folder - 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. + 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. 1. Saving window preferences - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. + 1. Resize the window to an optimum size. Move the window to a different location. Close the window. - 1. Re-launch the app by double-clicking the jar file.
+ 1. Re-launch the app by double-clicking the jar file.
Expected: The most recent window size and location is retained. 1. _{ more test cases …​ }_ @@ -674,16 +674,16 @@ testers are expected to do more *exploratory* testing. 1. Deleting a person while all persons are being shown - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + 1. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + 1. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. + 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. 1. _{ more test cases …​ }_ @@ -691,6 +691,6 @@ testers are expected to do more *exploratory* testing. 1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ + 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ 1. _{ more test cases …​ }_ From fb62ce1a22c21533a36f896cf6e5cdb9c0272e37 Mon Sep 17 00:00:00 2001 From: josepholim Date: Mon, 30 Oct 2023 04:25:34 +0800 Subject: [PATCH 3/4] remove unrelevant updates --- build.gradle | 4 ---- 1 file changed, 4 deletions(-) diff --git a/build.gradle b/build.gradle index 98c44b0dc9b..a2951cc709e 100644 --- a/build.gradle +++ b/build.gradle @@ -20,10 +20,6 @@ checkstyle { toolVersion = '10.2' } -run { - enableAssertions = true -} - test { useJUnitPlatform() finalizedBy jacocoTestReport From e5171109f321df3fec5c3e2830d20b23e9349af5 Mon Sep 17 00:00:00 2001 From: josepholim Date: Mon, 30 Oct 2023 04:30:08 +0800 Subject: [PATCH 4/4] Fix the layout --- docs/DeveloperGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 9263b30833e..b12c31e4cff 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -309,8 +309,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* * *` | user | delete a contact | remove a contact (by name) that I do not need | | `* * *` | user | view all contact | easily see and know what contacts are currently stored in the application in one place | | `* *` | user | view all notes | easily see and know what notes are currently stored in the application in one place | -| `* *` | user | add notes to a contact | record additional information about that contact as notes | -| `* *` | user | delete notes to a contact | remove additional information about that contact that are no longer relevant | +| `* *` | user | add notes to a contact | record additional information about that contact as a note | +| `* *` | user | delete notes to a contact | remove additional information about that contact that are no longer relevant | | `* *` | user who has some event to do | add an event | record an event with start time and also end time, location and any additional information like what to do during the event | | `* *` | user who has/had some event to do | delete an event | remove an event after it is obsolete, cancelled or no longer needed to be recorded | | `* *` | tidy user | tag a contact with a label | keep my contacts oraganised and categorised | @@ -693,4 +693,4 @@ testers are expected to do more *exploratory* testing. 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ -1. _{ more test cases …​ }_ +1. _{ more test cases …​ }_ \ No newline at end of file