Expected: An error message stating what is considered a valid Role.
- 1. Other invalid Roles include: `Software_Engineer_Intern`, `Cl-erk`.
+ 1. Other invalid Roles include: `Software_Engineer_Intern`, `Cl-erk`.
3. Missing/Invalid Email test case: `/add n/Google r/Software Engineer Intern e/ d/31/10/24`
Expected: An error message stating what is considered a valid Email. - 1. Other invalid Emails include: `@gmail.com`, `google.com`, `domainLabelTooShort@gmail.x`.
+ 1. Other invalid Emails include: `@gmail.com`, `google.com`, `domainLabelTooShort@gmail.x`.
4. Missing/Invalid Date test case: `/add n/Google r/Software Engineer Intern e/google@gmail.com d/`
Expected: An error message stating what is considered a valid Date. - 1. Other invalid Dates include: Dates in the future (Relative to device's clock), `30/02/2024`, `31/04/2024`.
+ 1. Other invalid Dates include: Dates in the future (Relative to device's clock), `30/02/2024`, `31/04/2024`.
5. Adding internship application with missing field(s) 1. Test case: `/add n/Google r/Software Engineer Intern e/google@gmail.com`
@@ -1076,7 +1074,7 @@ testers are expected to do more *exploratory* testing. 1. Exit via Window's close button 1. Test case: Close the window by clicking on the Window's close button.
- Expected: The window should close. + Expected: The window should close.
2. Exit via exit command @@ -1125,7 +1123,7 @@ on why the command is invalid. The error message could be more specific to state - Justification: By providing distinct error messages for each command, we improve the user experience by making error feedback more specific and actionable. Users will be able to identify errors related to each command easily, reducing potential confusion and enhancing usability.
7. **Improve chart UI** -
+ - Current behaviour: When there are multiple statuses with zero internship applications, not all status labels are shown.
- Planned enhancement: Remove chart labels for statuses with zero internship applications.
- Justification: This ensures a consistent and user-friendly chart view which makes it easier for users to interpret the chart.
@@ -1151,7 +1149,3 @@ on why the command is invalid. The error message could be more specific to state - Current behaviour: Internship applications data is stored in a single data file `hireme.json`.
- Planned enhancement: A backup file that replicates the data in `hireme.json`.
- Justification: Having only a single data file to store internship applications data means having a single point of failure when the data in corrupted or lost. A backup file that synchronously replicates the data in `hireme.json` ensures data redundancy.
- -## **Appendix: Known Issues** - -1. If the user opens the application on a first monitor, then moves the application window to a second monitor and closes the application, then when the user tries to open the application again, the application would not work after opening. The current work around is that the user will then have to move the application window back to the first monitor for the application to work. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 33b8aa1ac11..70ae76a5d90 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -56,6 +56,7 @@ HireMe is a **free desktop application that helps you manage your extensive list * [HireMe application setup failed](#hireme-application-setup-failed) * [Getting errors when using the commands](#getting-errors-when-using-the-commands) * [Unable to see the full text on the screen](#unable-to-see-the-full-text-on-the-screen) + * [Known Issues](#known-issues) * [Command summary](#command-summary) * [Glossary](#glossary) * [Acknowledgements](#acknowledgements) @@ -490,6 +491,12 @@ Try opening the window to full screen or scroll to view the full text. Avoid inp -------------------------------------------------------------------------------------------------------------------- +## Known Issues + +1. If the user opens the application on a first monitor, then moves the application window to a second monitor and closes the application, then when the user tries to open the application again, the application would not work after opening. The current work around is that the user will then have to move the application window back to the first monitor for the application to work. + +-------------------------------------------------------------------------------------------------------------------- + ## Command summary Action | Format, Examples diff --git a/docs/_markbind/layouts/default.md b/docs/_markbind/layouts/default.md index e243800219c..a21343ebd15 100644 --- a/docs/_markbind/layouts/default.md +++ b/docs/_markbind/layouts/default.md @@ -31,6 +31,7 @@ * [Features]({{ baseUrl }}/UserGuide.html#features) * [FAQ]({{ baseUrl }}/UserGuide.html#faq) * [Troubleshooting]({{ baseUrl }}/UserGuide.html#troubleshooting) + * [Known Issues]({{ baseUrl }}/UserGuide.html#known-issues) * [Command summary]({{ baseUrl }}/UserGuide.html#command-summary) * [Glossary]({{ baseUrl }}/UserGuide.html#glossary) * [Acknowledgements]({{ baseUrl }}/UserGuide.html#acknowledgements) @@ -43,7 +44,6 @@ * [Appendix: Requirements]({{ baseUrl }}/DeveloperGuide.html#appendix-requirements) * [Appendix: Instructions for manual testing]({{ baseUrl }}/DeveloperGuide.html#appendix-instructions-for-manual-testing) * [Appendix: Planned Enhancements]({{ baseUrl }}/DeveloperGuide.html#appendix-planned-enhancements) - * [Appendix: Known Issues]({{ baseUrl }}/DeveloperGuide.html#appendix-known-issues) * [About Us]({{ baseUrl }}/AboutUs.html)