From 27fdf9bcc1cadf81dc45950a2fa956aeef283f0a Mon Sep 17 00:00:00 2001 From: choaticman Date: Tue, 12 Nov 2024 00:33:59 +0800 Subject: [PATCH 1/3] Add points to planned enhancements --- docs/DeveloperGuide.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index b58415c2e22..e892c79d7c3 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1137,4 +1137,26 @@ testers are expected to do more *exploratory* testing. ## **Appendix: Planned Enhancements** The team consists of 5 members. -Given below are enhancements planned for future versions. +Given below are enhancements planned for future versions.
+ +1. **Make 'Roles' and 'Company Names' less restrictive:** The current validator is too restrictive on what is allowed as `Role` and `Company Name`. +Valid roles such as: C++ Developer, C# Developer, R&D Specialist are currently flagged as invalid by the validator. +Similarly, valid company names such as: A*STAR, SK-II, Yahoo!, John's Bakery are also flagged as invalid by the validator. +We plan to loosen the restrictions for roles and company names, to be more inclusive of the possible roles and company names in the real world.
+ +2. **Improve consistency in `find` feature:** Currently, while we prevent special characters in the `Company Name` (such as ~\`!@#), +we did not prevent the same characters from being used as keywords for the `find` feature. This leads to an inconsistent user experience, +since these characters would never be found in company names. We plan to be more consistent, +and check whether the keywords provided to the `find` command are valid characters that are allowed in `Company Name`.
+ +3. **Make error message for `add` command more specific:** Currently, the error message provided when the user inputs an invalid `add` command is too generic. +For example, `/add n/Google r/SWE d/01/01/24` will provide an error message stating `Invalid command format!`. It does not provide additional information to the user, +on why the command is invalid. It could be improved to state the email field is missing. +We plan to implement a checker to check the command provided by the user, and provide a more specific error message depending on why the command is invalid. + +4. **Improve UI to deal with long texts:** The current application does not allow the user to scroll the list displayed on the application. +If there is a very long text, the text will be cut off and the use would have to maximise the application's window in order to see the full text. +We plan to implement scroll bars within the list displayed in the application, to allow the user to scroll and see any long texts. + +5. **Improve the validator for `email`:** The current email validator flags valid emails as invalid, such as `faceb__k@fb.com.sg`. This could cause some inconvenience to the users. +We plan to fix the validator for email to allow for more valid emails. From 1a2aa59e73d8c4b18d387066d43721f19518d07a Mon Sep 17 00:00:00 2001 From: choaticman Date: Tue, 12 Nov 2024 00:39:55 +0800 Subject: [PATCH 2/3] Add spacing --- docs/DeveloperGuide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index e892c79d7c3..741156b8537 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1152,11 +1152,12 @@ and check whether the keywords provided to the `find` command are valid characte 3. **Make error message for `add` command more specific:** Currently, the error message provided when the user inputs an invalid `add` command is too generic. For example, `/add n/Google r/SWE d/01/01/24` will provide an error message stating `Invalid command format!`. It does not provide additional information to the user, on why the command is invalid. It could be improved to state the email field is missing. -We plan to implement a checker to check the command provided by the user, and provide a more specific error message depending on why the command is invalid. +We plan to implement a checker to check the command provided by the user, and provide a more specific error message depending on why the command is invalid.
4. **Improve UI to deal with long texts:** The current application does not allow the user to scroll the list displayed on the application. If there is a very long text, the text will be cut off and the use would have to maximise the application's window in order to see the full text. -We plan to implement scroll bars within the list displayed in the application, to allow the user to scroll and see any long texts. +We plan to implement scroll bars within the list displayed in the application, to allow the user to scroll and see any long texts.
5. **Improve the validator for `email`:** The current email validator flags valid emails as invalid, such as `faceb__k@fb.com.sg`. This could cause some inconvenience to the users. -We plan to fix the validator for email to allow for more valid emails. +We plan to fix the validator for email to allow for more valid emails.
+ From 5423205b4f4d2a7d07d5d08ccf680a1bf97bb62c Mon Sep 17 00:00:00 2001 From: choaticman Date: Tue, 12 Nov 2024 00:49:05 +0800 Subject: [PATCH 3/3] Improve phrasing --- docs/DeveloperGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 741156b8537..25d3ca00a43 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1152,7 +1152,7 @@ and check whether the keywords provided to the `find` command are valid characte 3. **Make error message for `add` command more specific:** Currently, the error message provided when the user inputs an invalid `add` command is too generic. For example, `/add n/Google r/SWE d/01/01/24` will provide an error message stating `Invalid command format!`. It does not provide additional information to the user, on why the command is invalid. It could be improved to state the email field is missing. -We plan to implement a checker to check the command provided by the user, and provide a more specific error message depending on why the command is invalid.
+We plan to improve the validator to be able to detect specifically why the command is invalid, and provide a more specific error message.
4. **Improve UI to deal with long texts:** The current application does not allow the user to scroll the list displayed on the application. If there is a very long text, the text will be cut off and the use would have to maximise the application's window in order to see the full text.