Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix known issues docs #357

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
* [Saving data](#saving-data)
* [Exit HireMe](#exit-hireme-application)
* [**Appendix: Planned Enhancements**](#appendix-planned-enhancements)
* [**Appendix: Known Issues**](#appendix-known-issues)
<!-- TOC -->
<page-nav-print />

Expand Down Expand Up @@ -700,8 +699,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (futu
- **Application Status**:
- **PENDING**: The internship application is currently in progress.
- **REJECTED**: The user has rejected or been rejected from this internship application.
- **ACCEPTED**: The user has accepted the offer for this internship.

- **ACCEPTED**: The user has accepted the offer for this internship. <br></br>

- **Action**: The task carried out by the HireMe application such as Add, Delete, Update entries.

Expand Down Expand Up @@ -842,19 +840,19 @@ testers are expected to do more *exploratory* testing.

1. Missing/Invalid Company Name test case: `/add n/ r/Software Engineer Intern e/google@gmail.com d/31/10/24` <br>
Expected: An error message stating what is considered a valid Company Name.<br>
1. Other invalid Company Names include: `<oding lab`, `|-|appy Days`, `@pple`.<br>
1. Other invalid Company Names include: `<oding lab`, `|-|appy Days`, `@pple`.<br></br>

2. Missing/Invalid Role test case: `/add n/Google r/ e/google@gmail.com d/31/10/24` <br>
Expected: An error message stating what is considered a valid Role.<br>
1. Other invalid Roles include: `Software_Engineer_Intern`, `Cl-erk`.<br>
1. Other invalid Roles include: `Software_Engineer_Intern`, `Cl-erk`.<br></br>

3. Missing/Invalid Email test case: `/add n/Google r/Software Engineer Intern e/ d/31/10/24`<br>
Expected: An error message stating what is considered a valid Email.
1. Other invalid Emails include: `@gmail.com`, `google.com`, `domainLabelTooShort@gmail.x`.<br>
1. Other invalid Emails include: `@gmail.com`, `google.com`, `domainLabelTooShort@gmail.x`.<br></br>

4. Missing/Invalid Date test case: `/add n/Google r/Software Engineer Intern e/google@gmail.com d/`<br>
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`.<br>
1. Other invalid Dates include: Dates in the future (Relative to device's clock), `30/02/2024`, `31/04/2024`.<br></br>

5. Adding internship application with missing field(s)
1. Test case: `/add n/Google r/Software Engineer Intern e/google@gmail.com`<br>
Expand Down Expand Up @@ -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.<br>
Expected: The window should close.
Expected: The window should close. <br></br>

2. Exit via exit command

Expand Down Expand Up @@ -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. <br></br>

7. **Improve chart UI**
<img src="images/chart-ui-bug.png" alt="chart-ui-bug">
<img src="images/chart-ui-bug.png" alt="chart-ui-bug"> <br></br>
- Current behaviour: When there are multiple statuses with zero internship applications, not all status labels are shown. <br></br>
- Planned enhancement: Remove chart labels for statuses with zero internship applications. <br></br>
- Justification: This ensures a consistent and user-friendly chart view which makes it easier for users to interpret the chart. <br></br>
Expand All @@ -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`. <br></br>
- Planned enhancement: A backup file that replicates the data in `hireme.json`. <br></br>
- 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. <br></br>

## **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.
7 changes: 7 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
</site-nav>
</div>
Expand Down