Skip to content

Commit

Permalink
Merge branch 'master' into branch-DG-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
wamps-jp authored Nov 13, 2023
2 parents 5df6a90 + 9b9ff7c commit f0896f5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -973,9 +973,7 @@ testers are expected to do more *exploratory* testing.
1. Resize the window to an optimum size. Move the window to a different location. Close the window.

1. Re-launch the app by double-clicking the jar file.<br>
Expected: The most recent window size and location is retained. // TODO: Check if it is valid.

1. _{ more test cases …​ }_
Expected: The most recent window size and location is retained.

### Resetting to default data for Jobby

Expand Down Expand Up @@ -1060,11 +1058,20 @@ testers are expected to do more *exploratory* testing.
### Saving data

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. Prerequisite: None.
2. Test case: Delete half of a contact in the json data file. <br>
Expected: An empty list of contacts and applications are displayed on startup.
3. Test case: Delete the data file in Jobby's home folder. <br>
Expected: The sample list of contacts and applications is displayed on startup.

2. Modifying the list of contacts and job applications
1. Prerequisite: Having existing contacts and applications when editing or deleting data.
2. Test case: Adding a new contact/job application and closing the application. <br>
Expected: The new contact/job application is displayed when the application starts up again.
3. Test case: Editing an existing contact/job application <br>
Expected: The edits are saved and is correctly displayed when the application starts up again.
4. Test case: Deletes an existing contact/job application <br>
Expected: The contact/job application is not displayed when the application starts up again.

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

Expand Down
11 changes: 11 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -737,6 +737,17 @@ exit

Exits the program.

### Saving the data

Jobby's data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

### Editing the data file

Jobby's data are saved automatically as a JSON file `[JAR file location]/data/jobby.json`. Advanced users are welcome to update data directly by editing that data file.

<div markdown="block" class="alert alert-warning">
:warning: **Caution:** If your changes to the data file makes its format invalid, Jobby will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
</div>

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

Expand Down

0 comments on commit f0896f5

Please sign in to comment.