Skip to content

Commit

Permalink
Merge branch 'master' into branch-UGDG
Browse files Browse the repository at this point in the history
* master:
  Update participants to persons in  DeveloperGuide.md
  Update Ui image
  • Loading branch information
julia-cp committed Apr 15, 2024
2 parents 3be719a + ff7a0eb commit e2b1965
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 33 deletions.
Binary file added Ui-updated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 35 additions & 33 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,19 +376,19 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|-----------------------------|--------------------------------------------------|---------------------------------------------------------------|
| `* * *` | Student Hackathon Organizer | Add new participants to the contact managing app | Have a centralized database of all hackathon attendees. |
| `* * *` | Student Hackathon Organizer | Update and edit participant contact details | Ensure accurate and up-to-date information. |
| `* * *` | Student Hackathon Organizer | Add new persons to the contact managing app | Have a centralized database of all hackathon attendees. |
| `* * *` | Student Hackathon Organizer | Update and edit person contact details | Ensure accurate and up-to-date information. |
| `* * *` | Student Hackathon Organizer | Add notes or comments to contact | Provide additional context or reminders for each contact. |
| `* * *` | Student Hackathon Organizer | View contact count in the database | Know the number of participants, staff, etc. in the event |
| `* * *` | Student Hackathon Organizer | View comment of a specific participant | Have a quick reference to the important notes for a contact |
| `* * *` | Student Hackathon Organizer | View contact count in the database | Know the number of participants, staff and sponsors in the event |
| `* * *` | Student Hackathon Organizer | View comment of a specific person | Have a quick reference to the important notes for a contact |
| `* * *` | Student Hackathon Organizer | List out members | See all the members in one go |
| `* * *` | Student Hackathon Organizer | Find a participant with keyword | Effectively search for a specific participant's information |
| `* * *` | Student Hackathon Organizer | Find a person with keyword | Effectively search for a specific person's information |
| `* * *` | Student Hackathon Organizer | Export specific contact details to a CSV file | Share contact information with sponsors |
| `* * *` | Student Hackathon Organizer | Remove specific participants | remove participants who signed up but unable to participate. |
| `* * *` | Student Hackathon Organizer | Remove specific participants | Remove participants who signed up but unable to participate. |
| `* * *` | Student Hackathon Organizer | Remove specific persons | remove participants who signed up but unable to participate. |
| `* * *` | Student Hackathon Organizer | Remove specific persons | Remove persons who are no longer involved in the hackathon. |
| `* * *` | Student Hackathon Organizer | Group specific participants | Know which participants are working together. |
| `* * *` | Student Hackathon Organizer | Group specific staff | Assign easily a staff to a group. |
| `* * *` | Student Hackathon Organizer | Randomly group all participants | Quickly ensure that all participants have a group. |
| `* * *` | Student Hackathon Organizer | Randomly group all participants and staff | Quickly ensure that all participants and staff have a group. |
| `* * *` | Student Hackathon Organizer | Add events for specific categories of people | Have a database with all the events related to hackathon. |
| `* * *` | Student Hackathon Organizer | Delete event | Remove events that have been cancelled or no longer relevant. |
| `* * *` | Student Hackathon Organizer | Find events | Find details such as date and category of an upcoming event |
Expand Down Expand Up @@ -432,24 +432,24 @@ otherwise)

<br>

**Use case: View Participant List**
**Use case: View Persons List**

**MSS**

1. User requests to view the list of all participants.
1. User requests to view the list of all persons.
2. System displays the list with relevant information.
3. System shows the total count of participants.
3. System shows the total count of persons.

Use case ends.

<br>

**Use case: Update Participant Contact Details**
**Use case: Update Person Contact Details**

**MSS**

1. User requests to update contact details for a specific participant.
2. System prompts for the participant's name and the field to update.
1. User requests to update contact details for a specific person.
2. System prompts for the person's name and the field to update.
3. User provides valid information.
4. System validates input and updates the contact details.
5. System displays a success message.
Expand All @@ -470,7 +470,7 @@ otherwise)
**MSS**

1. User requests to add comments to a person by providing the person's index and the comment.
2. System replace the old comment data of the participant's into a new comment.
2. System replace the old comment data of the person's into a new comment.
3. System displays a success message.

Use case ends.
Expand All @@ -487,28 +487,28 @@ otherwise)

<br>

**Use case: Remove Participant**
**Use case: Remove Person**

**MSS**

1. User requests to remove a specific participant.
2. System prompts for the participant's ID.
1. User requests to remove a specific person.
2. System prompts for the person's ID.
3. User provides the ID.
4. System deletes the participant.
4. System deletes the person.
5. System displays a success message.

Use case ends.

**Extensions**

3a. Participant not found.
3a. Person not found.

- System displays an error message.
- Use case ends.

<br>

**Use case: Find Participant by keywords**
**Use case: Find Person by keywords**

**MSS**

Expand Down Expand Up @@ -545,13 +545,13 @@ otherwise)

<br>

**Use case: Group A Participant**
**Use case: Group A Participant or Staff**

**MSS**

1. User requests to group a specific participant to a specific group.
2. User provides valid information: participant's ID and group number.
3. System groups the participant into the group number.
1. User requests to group a specific participant or staff to a specific group.
2. User provides valid information: participant/staff's ID and group number.
3. System groups the participant/staff into the group number.
4. System displays a success message.

Use case ends.
Expand Down Expand Up @@ -583,14 +583,14 @@ otherwise)

<br>

**Use case: Randomly Group All Participant**
**Use case: Randomly Group All Participants/Staff**

**MSS**

1. User requests to find participant in the current list.
2. User requests to group randomly all persons in the current list.
1. User requests to find participant/staff in the current list.
2. User requests to group randomly all participants/staff in the current list.
3. User provides valid maximum group size.
4. System assigns randomly all participants into a group, where each group
4. System assigns randomly all participants/staff into a group, where each group
size is less than or equal to the maximum group size.
5. System displays a success message.

Expand Down Expand Up @@ -675,7 +675,7 @@ otherwise)

1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed.
2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
3. The application should be designed to scale gracefully, accommodating an increase in the number of participants or
3. The application should be designed to scale gracefully, accommodating an increase in the number of persons or
contacts without significant degradation in performance.
4. The codebase should follow best practices and be well-documented to facilitate future maintenance and updates by
developers.
Expand All @@ -687,7 +687,9 @@ otherwise)
- **Mainstream OS**: Windows, Linux, Unix, MacOS
- **Java 11**: A version of the Java programming language and runtime environment, required for running the application
- **Participant**: An individual registered to participate in the hackathon
- **ID**: A unique identifier assigned to each participant in the system
- **Staff**: An individual working at/overseeing the hackathon
- **Sponsor**: An individual who is a sponsor for the hackathon
- **ID**: A unique identifier assigned to each person in the system

---

Expand Down Expand Up @@ -847,10 +849,10 @@ testers are expected to do more *exploratory* testing.

### Group randomly all persons

1. **Randomly grouping all participants and staffs in the list**
1. **Randomly grouping all participants and staff in the list**
1. Prerequisites: Multiple persons in the list.
2. Test case: `grouprandom 3`<br>
Expected: All participants and staffs are assigned into a random group number.
Expected: All participants and staff are assigned into a random group number.
Each group have less than or equal to 3 members.
3. Test case: `grouprandom x` (where x is larger than the list size) <br>
Expected: All participants and staffs are assigned into group 1.
Expand Down

0 comments on commit e2b1965

Please sign in to comment.