Skip to content

Commit

Permalink
Merge pull request #225 from KhoonSun47/branch-add-developer-guide-7
Browse files Browse the repository at this point in the history
Update Documentation
  • Loading branch information
felixchanyy authored Apr 13, 2024
2 parents fa72d9f + fc46943 commit 3777d70
Showing 1 changed file with 34 additions and 6 deletions.
40 changes: 34 additions & 6 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,8 @@ testers are expected to do more *exploratory* testing.

1. Download the jar file and copy into an empty folder

1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
1. Double-click the jar file
Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

1. Saving window preferences

Expand All @@ -914,8 +915,8 @@ testers are expected to do more *exploratory* testing.
1. **Loading Data:**

- To test the application's response to a missing data folder or `addressbook.json` file, manually delete the `data` folder or the `addressbook.json` file from it.
- The application should automatically populate EstateEase with sample data, displaying buyers and sellers, where sellers are associated with houses.

- The application should automatically populate EstateEase with sample data, displaying buyers and sellers, where sellers are associated with houses. <br>
<br>
1. **Dealing with Corrupted Data Files**

1. **Loading Data:**
Expand All @@ -926,6 +927,34 @@ testers are expected to do more *exploratory* testing.
- These three actions violates EstateEase's constraints against duplicate houses, person and incorrect format, hence making the `addressbook.json` corrupted.
- The application should automatically detect this, and display an empty EstateEase.

[//]: # (@@author KhoonSun47)
### Adding a seller

**Prerequisites:**
- List all persons using the `list` command.
- There is currently no `person` with the name "John Carl", "John Felix", "John Zy". <br>

1. **Add seller**
1. **Test case** (add a `seller` named `John Carl 1` with a house `Hdb`): `addSeller n/John Carl 1 p/98765432 e/johncarl1@example.com type/Hdb street/Clementi Ave 2 blk/311 level/02 unitNo/25 postal/578578 price/999999999`<br>
**Expected**: A new seller is added, with name `John Carl 1`, phone `98765432`, email `johncarl@example.com` and `Hdb` house details with street `Clementi Ave 2`, with block `311`, with level `02`, with unit number `25`, with postal code `578578` and price `999999999`. <br><br>

2. **Test case** (add a `seller` named `John Felix` with a house `Condominium`): `addSeller n/John Felix p/98765433 e/johnfelix@example.com type/Condominium street/Clementi Ave 3 blk/N/A level/03 unitNo/26 postal/578579 price/100000`<br>
**Expected**: A new seller is added, with name `John Felix`, phone `98765433`, email `johnfelix@example.com` and `Condominium` house details with street `Clementi Ave 3`, with block `N/A`, with level `03`, with unit number `26`, with postal code `578579` and price `100000`. <br><br>

3. **Test case** (add a `seller` named `John Carl 2` with a house `Landed`): `addSeller n/John Carl 2 p/98765434 e/johncarl2@example.com type/Landed street/Clementi Ave 4 unitNo/26 postal/578580 price/1000000`<br>
**Expected**: A new seller is added, with name `John Carl 2`, phone `98765434`, email `johncarl2@example.com` and `Landed` house details with street `Clementi Ave 4`, with unit number `26`, with postal code `578580` and price `1000000`. <br><br>

2. **Invalid format**
1. **Test case** (add a `seller` without compulsory details): `addSeller` <br>
**Expected**: No seller is added. Error indicating invalid format with constraints shown. <br><br>

3. **Invalid (Duplicate)**
1. **Test case** (Duplicate seller -> seller and buyer cannot be same name): `addSeller n/John Carl 1 p/98765432 e/johncarl1@example.com type/Landed street/Clementi Ave 2 unitNo/25 postal/578578 price/10000`
**Expected**: No seller is added. Error indicating that the person already existed in the data. <br><br>

2. **Test case** (Duplicate house): `addSeller n/Carl Lim p/98765432 e/johncarl@example.com type/Hdb street/Clementi Ave 2 blk/311 level/02 unitNo/25 postal/578578 price/999999999` <br>
**Expected**: No seller is added. Error indicating that the house already existed in the data. <br>

[//]: # (@@author redcolorbicycle)
### Adding a house to a seller

Expand Down Expand Up @@ -994,7 +1023,6 @@ testers are expected to do more *exploratory* testing.
1. **Test case:** `addHouse n/Lim Carl type/Condominium street/Clementi Ave 2 blk/N/A level/02 unitNo/25 postal/578578 price/99999`<br>
**Expected:** This Seller does not exist in EstateEase


[//]: # (@@author zengzihui)
### Viewing a person

Expand Down Expand Up @@ -1112,8 +1140,8 @@ similar to the test cases found in `Editing Seller Details`.

- If the `data` folder is deleted, the application will recreate it along with a new `addressbook.json` file upon executing a valid command.
- If only the `addressbook.json` file is deleted, it will be recreated within the existing `data` folder upon executing a valid command.
- The application saves the sample data to `addressbook.json` upon executing a valid command.

- The application saves the sample data to `addressbook.json` upon executing a valid command. <br>
<br>
1. **Dealing with Corrupted Data Files**

1. **Saving Data:**
Expand Down

0 comments on commit 3777d70

Please sign in to comment.