Skip to content

Commit

Permalink
Add points to planned enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
choaticman committed Nov 11, 2024
1 parent b2db9e0 commit 27fdf9b
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br>

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. <br>

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`. <br>

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.

0 comments on commit 27fdf9b

Please sign in to comment.