Skip to content

Commit e568329

Browse files
authored
Merge pull request #391 from GuoGangQuan/branch-add-repo-use-case
Branch add repo use case and improve DG format consistency for use case
2 parents 8062aac + 9aec7ba commit e568329

File tree

1 file changed

+62
-6
lines changed

1 file changed

+62
-6
lines changed

docs/DeveloperGuide.md

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
487487
2. User chooses to delete a group from the list.
488488
3. SC deletes the group, keeping the member contacts, and displays details of the deleted group.
489489

490-
Use case ends.
490+
Use case ends.
491491

492492
**Extensions**
493493

@@ -506,7 +506,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
506506
1. User requests to list all contacts.
507507
2. SC displays a list of all contacts and their details.
508508

509-
Use case ends.
509+
Use case ends.
510510

511511
**Extensions**
512512

@@ -526,7 +526,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
526526
1. User requests to list groups.
527527
2. SC shows user a list of all groups and their details.
528528

529-
Use case ends.
529+
Use case ends.
530530

531531
**Extensions**
532532

@@ -548,7 +548,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
548548
2. User requests to view a specific contact’s details in the list.
549549
3. SC shows the user the given contact’s details.
550550

551-
Use case ends.
551+
Use case ends.
552552

553553
**Extensions**
554554

@@ -668,7 +668,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
668668

669669
Use case ends.
670670

671-
**System: StudyCircle (SC)**
671+
**System: StudyCircle (SC)**
672672
**Use Case: UC12 - Start a new project group with a deadline**
673673
**Actor: User**
674674

@@ -694,7 +694,63 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
694694
2. User chooses to delete a contact from the list.
695695
3. SC deletes the contact from the list and removes all the groups that they are attached to (if any).
696696

697-
Use case ends.
697+
Use case ends.
698+
699+
**System: StudyCircle (SC)**
700+
**Use Case: UC14 - Set a repository link for a group**
701+
**Actor: User**
702+
**Preconditions: The specified group already exists within SC**
703+
704+
**MSS**
705+
706+
1. User requests for a <u>list of groups (UC6)</u>.
707+
2. User enters repository link and specified group.
708+
3. SC sets the repository link for the specified group and displays a confirmation message.
709+
710+
Use case ends.
711+
712+
**Extensions**
713+
714+
* 2a. The repository link input is invalid or empty.
715+
716+
* 2a1. SC shows an error message.
717+
718+
Use case resumes from step 2.
719+
720+
* 2b. The specified group already has a repository link.
721+
722+
* 2b1. SC replaces the existing repository link with the new one and notifies the user.
723+
724+
Use case ends.
725+
726+
* *a. At any point the user decides to cancel the operation.
727+
728+
Use case ends.
729+
730+
**System: StudyCircle (SC)**
731+
**Use Case: UC15 - Retrieve a Repository Link for a Group**
732+
**Actor: User**
733+
**Preconditions: The specified group already exists within StudyCircle (SC).**
734+
735+
**MSS**
736+
737+
1. User requests for a <u>list of groups (UC6)</u>.
738+
2. User enters the target group to retrieve its repository link.
739+
3. SC retrieves the repository link for the specified group.
740+
4. SC displays the repository link, copies it to the system clipboard and shows a confirmation message that the link has been copied.
741+
742+
Use case ends.
743+
744+
**Extensions**
745+
* 3a. The specified group does not have a repository link set.
746+
747+
* 3a1. SC shows a message indicating that no repository link has been set for the group.
748+
749+
Use case ends.
750+
751+
* *a. At any point the user decides to cancel the operation.
752+
753+
Use case ends.
698754

699755
### Non-Functional Requirements
700756

0 commit comments

Comments
 (0)