From f26f308c7319dfbcbcd27b0a51af93030691e1b8 Mon Sep 17 00:00:00 2001 From: Andrew22Teoh Date: Tue, 12 Nov 2024 03:51:58 +0800 Subject: [PATCH 1/4] Introduce dummy linebreak for push --- docs/UserGuide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 75a6055b564..d068ffb3dd9 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -364,3 +364,4 @@ Action | Format, Examples **Seed** | `seed` **Sort** | `sort PARAMETER_PREFIX/ORDER`
e.g., `sort n/ascending` **Remark** | `remark INDEX r/REMARK`
e.g., `remark 1 r/some remark about contact` + From 452d0db81dad0829be0d4de3663aa892d05008ef Mon Sep 17 00:00:00 2001 From: Andrew22Teoh Date: Tue, 12 Nov 2024 10:16:06 +0800 Subject: [PATCH 2/4] Add to planned enhancements --- docs/DeveloperGuide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index dea887d813a..e1302b96889 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -606,6 +606,14 @@ testers are expected to do more *exploratory* testing. ## **Appendix: Planned Enhancements** +For reference, our group has 5 members. + 1. Make `list` command with miscellaneous parameters error message more helpful. Currently, typing `list` with miscellaneous parameters, ex. `list 123`, will result in a message that states "Please ensure your command is valid!". To improve specificity this will be changed to ask user to remove miscellaneous parameters. 2. Prevent tags from allowing underscores. When searching for tags with underscores in the find command, the underscores are interpreted as an `or`. This means that searching for the tag "low_income" will bring up all tags containing "low" and "income" instead of just "low_income". -3. Remove `remark` command while keeping remarks. Currently, remarks can be added via the edit command or the remark command but not the add command. Instead of having a dedicated remark command we will allow users to use add command to add remarks while adding a contact and edit command to add or edit the remark of a contact. This change solves an associated issue whereby the remark command currently undoes the detailed view on the contact. +3. Remove `remark` command while keeping remark fields. Currently, remarks can be added via the edit command or the remark command but not the add command. Instead of having a dedicated remark command we will allow users to use add command to add remarks while adding a contact and edit command to add or edit the remark of a contact. This change solves an associated issue whereby the remark command currently undoes the detailed view on the contact. +4. Restrict the validation regex for emails to require at least 2 domain labels in the domainName region of the email. Traditionally, emails require at least 2 domain labels separated by a ., but the current implementation only requires one domain label. Something like johnsmith@yahoo is accepted as an email address when it should be rejected. +5. Update the error message displayed to the user by the `edit` command upon attempt to index with 0. The current error message for edit 0 n/Bob states invalid command format when it should mention that the index provided is invalid. +6. Update the error message displayed to the user by the `remark` command upon attempt to index with 0. The current error message for remark 0 r/Hates frisbees states invalid command format when it should mention that the index provided is invalid. +7. Update the error message displayed to the user by the `delete` command upon attempt to index with 0. The current error message for delete 0 states invalid command format when it should mention that the index provided is invalid. +8. Update the error message displayed to the user by the `view` command upon attempt to index with 0. The current error message for view 0 states invalid command format when it should mention that the index provided is invalid. +9. Include an example of sorting by date of last visit (`d/`) in the command format message of the `sort` command. \ No newline at end of file From d4177528045a03e138115601555a8b72fe62f4b5 Mon Sep 17 00:00:00 2001 From: Andrew22Teoh Date: Tue, 12 Nov 2024 10:21:21 +0800 Subject: [PATCH 3/4] Clarify text on remark enhancement --- docs/DeveloperGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index e1302b96889..d935ec1bc41 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -610,10 +610,10 @@ For reference, our group has 5 members. 1. Make `list` command with miscellaneous parameters error message more helpful. Currently, typing `list` with miscellaneous parameters, ex. `list 123`, will result in a message that states "Please ensure your command is valid!". To improve specificity this will be changed to ask user to remove miscellaneous parameters. 2. Prevent tags from allowing underscores. When searching for tags with underscores in the find command, the underscores are interpreted as an `or`. This means that searching for the tag "low_income" will bring up all tags containing "low" and "income" instead of just "low_income". -3. Remove `remark` command while keeping remark fields. Currently, remarks can be added via the edit command or the remark command but not the add command. Instead of having a dedicated remark command we will allow users to use add command to add remarks while adding a contact and edit command to add or edit the remark of a contact. This change solves an associated issue whereby the remark command currently undoes the detailed view on the contact. +3. Remove `remark` command while keeping remark fields. Currently, remarks can be added via the edit command or the remark command but not the add command. Instead of having a dedicated `remark` command, we will allow users to use the `add` command to create a contact with remarks, or the `edit` command to modify the remark of a contact. This change solves an associated issue whereby the remark command currently collapses the detailed view on the contact. 4. Restrict the validation regex for emails to require at least 2 domain labels in the domainName region of the email. Traditionally, emails require at least 2 domain labels separated by a ., but the current implementation only requires one domain label. Something like johnsmith@yahoo is accepted as an email address when it should be rejected. 5. Update the error message displayed to the user by the `edit` command upon attempt to index with 0. The current error message for edit 0 n/Bob states invalid command format when it should mention that the index provided is invalid. 6. Update the error message displayed to the user by the `remark` command upon attempt to index with 0. The current error message for remark 0 r/Hates frisbees states invalid command format when it should mention that the index provided is invalid. 7. Update the error message displayed to the user by the `delete` command upon attempt to index with 0. The current error message for delete 0 states invalid command format when it should mention that the index provided is invalid. 8. Update the error message displayed to the user by the `view` command upon attempt to index with 0. The current error message for view 0 states invalid command format when it should mention that the index provided is invalid. -9. Include an example of sorting by date of last visit (`d/`) in the command format message of the `sort` command. \ No newline at end of file +9. Include an example of sorting by date of last visit (`d/`) in the command format message of the `sort` command. From 1f2243af88e45209c5e855b8cad80ed51d8ea833 Mon Sep 17 00:00:00 2001 From: Andrew22Teoh Date: Tue, 12 Nov 2024 10:23:05 +0800 Subject: [PATCH 4/4] Fix formatting mistakes --- docs/DeveloperGuide.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index d935ec1bc41..0cf795f3352 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -612,8 +612,8 @@ For reference, our group has 5 members. 2. Prevent tags from allowing underscores. When searching for tags with underscores in the find command, the underscores are interpreted as an `or`. This means that searching for the tag "low_income" will bring up all tags containing "low" and "income" instead of just "low_income". 3. Remove `remark` command while keeping remark fields. Currently, remarks can be added via the edit command or the remark command but not the add command. Instead of having a dedicated `remark` command, we will allow users to use the `add` command to create a contact with remarks, or the `edit` command to modify the remark of a contact. This change solves an associated issue whereby the remark command currently collapses the detailed view on the contact. 4. Restrict the validation regex for emails to require at least 2 domain labels in the domainName region of the email. Traditionally, emails require at least 2 domain labels separated by a ., but the current implementation only requires one domain label. Something like johnsmith@yahoo is accepted as an email address when it should be rejected. -5. Update the error message displayed to the user by the `edit` command upon attempt to index with 0. The current error message for edit 0 n/Bob states invalid command format when it should mention that the index provided is invalid. -6. Update the error message displayed to the user by the `remark` command upon attempt to index with 0. The current error message for remark 0 r/Hates frisbees states invalid command format when it should mention that the index provided is invalid. -7. Update the error message displayed to the user by the `delete` command upon attempt to index with 0. The current error message for delete 0 states invalid command format when it should mention that the index provided is invalid. -8. Update the error message displayed to the user by the `view` command upon attempt to index with 0. The current error message for view 0 states invalid command format when it should mention that the index provided is invalid. +5. Update the error message displayed to the user by the `edit` command upon attempt to index with 0. The current error message for `edit 0 n/Bob` states "invalid command format" when it should mention that the index provided is invalid. +6. Update the error message displayed to the user by the `remark` command upon attempt to index with 0. The current error message for `remark 0 r/Hates frisbees` states "invalid command format" when it should mention that the index provided is invalid. +7. Update the error message displayed to the user by the `delete` command upon attempt to index with 0. The current error message for `delete 0` states "invalid command format" when it should mention that the index provided is invalid. +8. Update the error message displayed to the user by the `view` command upon attempt to index with 0. The current error message for `view 0` states "invalid command format" when it should mention that the index provided is invalid. 9. Include an example of sorting by date of last visit (`d/`) in the command format message of the `sort` command.