Skip to content

Commit

Permalink
Merge pull request #208 from ZweZeya/branch-zwe-update-docs
Browse files Browse the repository at this point in the history
Branch docs
  • Loading branch information
snowstopxt authored Nov 6, 2024
2 parents 7fb7c64 + 73d03ae commit f19c6b0
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![CI Status](https://github.com/AY2425S1-CS2103T-W09-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-W09-3/tp/actions)
[![codecov](https://codecov.io/gh/AY2425S1-CS2103T-W09-3/tp/graph/badge.svg?token=JZ0L5L0Q7Y)](https://codecov.io/gh/AY2425S1-CS2103T-W09-3/tp)

![Ui](docs/images/Ui.png)
Expand Down
79 changes: 75 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -762,7 +762,17 @@ testers are expected to do more *exploratory* testing.


[//]: # (Clear + List section here)

1. **Clear all internship applications**
1. Prerequisites: Ensure that the list is not empty. Reduce the view size of list by executing an arbitrary '\find' command. e.g. `\find a`.
2. Test case: `/clear`<br>
Expected: A success message stating that HireMe has been cleared.
3. Test case: `/list`<br>
Expected: The list of internship application remains empty.

2. **Clear all internship applications with invalid command format**
1. Prerequisites: Ensure that the list is not empty. Reduce the view size of list by executing an arbitrary '\find' command. e.g. `\find a`.
2. Test case: `/clear x`<br>
Expected: An error message stating the valid use of the `/clear` command.

### Adding an internship application
1. Adding an valid internship application
Expand Down Expand Up @@ -813,6 +823,15 @@ testers are expected to do more *exploratory* testing.


[//]: # (List section here)
1. **List all internship applications**
1. Prerequisites: Ensure that the list is not empty. Reduce the view size of list by executing an arbitrary '\find' command. e.g. `\find a`.
2. Test case: `/list`<br>
Expected: The list should display all internship applications.

2. **List all internship applications with invalid command format**
1. Prerequisites: Ensure that the list is not empty. Reduce the view size of list by executing an arbitrary '\find' command. e.g. `\find a`.
2. Test case: `/list x`<br>
Expected: An error message stating the valid use of the `/list` command.


### Deleting an internship application
Expand Down Expand Up @@ -917,11 +936,63 @@ testers are expected to do more *exploratory* testing.


[//]: # (Chart section here)

1. **Open chart window**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that there is are at least two internship applications with different statuses and the chart window is not opened.
2. Test case `/chart`<br>
Expected: Chart window opens.

2. **Open chart window with invalid command format**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that there is are at least two internship applications with different statuses and the chart window is not opened.
2. Test case: `/chart x`<br>
Expected: An error message stating the valid use of the `/chart` command.

3. **Update chart window by updating status**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that there is are the internship application at index 1 is of `PENDING` status and the chart window is already opened.
2. Test case: `/accept 1`<br>
Expected: Pie chart on chart window to update accordingly.

4. **Update chart window by adding an internship application**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that there is at least one internship application, `Google` is not in list, and the chart window is already opened.
2. Test case: `/add n/Google r/Software Engineer Intern e/google@gmail.com d/31/10/24`<br>
Expected: Pie chart on chart window to update accordingly.

5. **Update chart window by deleting an internship application**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that there is at are at least two internship applications and the chart window is already opened.
2. Test case: `/delete 1`<br>
Expected: Pie chart on chart window to update accordingly.

6. **Close chart window**
1. Prerequisites: Chart window is already opened.
2. Test case: Click on the close button on the Help window. <br>
Expected: Help window closes.

[//]: # (Filter section here)


1. **Filter with a valid status in uppercase**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that there is at least one internship application with `PENDING` status.
2. Test case `/filter PENDING`<br>
Expected: The list of internship applications should only display entries with `PENDING` status.

2. **Filter with a valid status in mixed case**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that there is at least one internship application with `PENDING` status.
2. Test case `/filter Pending`
Expected: The list of internship applications should only display entries with `PENDING` status.

3. **Filter an empty list**
1. Prerequisites: Clear all internship applications using the `/clera` command.
2. Test case `/filter PENDING`
Expected: The list of internship applications remains empty.

4. **Filter with an invalid status**
1. Prerequisites: List all internship applications using the `/list` command. Ensure that the list is not empty.
2. Test case `/filter approved`
Expected: An error message indicating that the status is invalid.

5. **Filter with an empty status**
1. Prerequisites: Clear all internship applications using the `/list` command. Ensure that the list is not empty.
2. Test case `/filter `
Expected: An error message indicating that the status is invalid.

[//]: # (Delete section here)


Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

# HireMe

[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
[![CI Status](https://github.com/AY2425S1-CS2103T-W09-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-W09-3/tp/actions)
[![codecov](https://codecov.io/gh/AY2425S1-CS2103T-W09-3/tp/graph/badge.svg?token=JZ0L5L0Q7Y)](https://codecov.io/gh/AY2425S1-CS2103T-W09-3/tp)

![Ui](images/Ui.png)

Expand Down

0 comments on commit f19c6b0

Please sign in to comment.