Skip to content

Commit

Permalink
Merge pull request #105 from Dominic-Khoo/branch-ug-sort
Browse files Browse the repository at this point in the history
Add acknowledgements and additional test cases to DG
  • Loading branch information
Dominic-Khoo authored Nov 7, 2024
2 parents 255a224 + 3cbfd75 commit 9eb7ea8
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

### Dominic Khoo

<img src="images/dominic_khoo.png" width="200px">
<img src="images/dominic-khoo.png" width="200px">

[[github](http://github.com/Dominic-Khoo)]
[[portfolio](team/johndoe.md)]
Expand Down
22 changes: 18 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@ title: Developer Guide

## **Acknowledgements**

* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
* This project is based on the [AddressBook Level 3](https://github.com/se-edu/addressbook-level3) project by SE-EDU.
It includes reused and adapted ideas, code, and documentation from the AddressBook Level 3 project.


* Reused/adapted components:
* UI component structure
* Command structure in Logic
* Storage management
* Project architecture and organization

--------------------------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -490,6 +498,12 @@ testers are expected to do more *exploratory* testing.

1. Dealing with missing/corrupted data files

1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_

1. _{ more test cases …​ }_
1. Simulating a Missing Data File
1. Locate the data file used by the application `data/addressbook.json`
2. Move or delete this file before launching the application<br>
Expected: The application should automatically create an empty data file, without displaying any errors and the application should function normally.
2. Simulating a Corrupted Data File
1. Open the data file `data/addressbook.json` in a text editor.
2. Introduce invalid JSON syntax into the file.
3. Save the corrupted file and launch the application.<br>
Expected: Application will display an error message to the user, indicating that the data is corrupted.
4 changes: 2 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Adds a remark to a specified patient profile.

Format: `remark NRIC r/REMARK`

Examples:
Examples:
* `remark S1234567A r/allergic to dogs`
* `remark T1231231D r/keep away from flashing lights`

Expand Down Expand Up @@ -204,7 +204,7 @@ _Details coming soon ..._
**Q**: How do I transfer my data to another Computer?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Murphy's List home folder.
**Q**: What should I do if the application does not start?<br>
**A**: Ensure you have Java `17` or above installed in your Computer. If the problem persists, contact the developers.
**A**: Ensure you have Java `17` or above installed in your Computer. If the problem persists, contact the developers.
You can check your Java version by running `java -version` in the command terminal.
**Q**: How do I recover data if I accidentally delete a patient profile?
**A**: Unfortunately, there is no built-in undo feature for deleted data. It is recommended to back up your data by making a copy of the data file periodically.
Expand Down
File renamed without changes

0 comments on commit 9eb7ea8

Please sign in to comment.