Skip to content

Commit

Permalink
Merge pull request #357
Browse files Browse the repository at this point in the history
Justify the rules for duplicate
  • Loading branch information
CYX22222003 authored Nov 10, 2024
2 parents 7b8bb7b + a75dd28 commit f2b87e7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
14 changes: 9 additions & 5 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

**Use case: UC04 - Add tags to a contact**
**Use case: UC04 - Add tags to a contact**

**Precondition**: Contact to add tags to already exists

**MSS**
Expand All @@ -417,7 +418,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

**Use cases: UC05 - Delete a tag from a contact**
**Use case: UC05 - Delete a tag from a contact**

**Precondition**: Contact to delete a tag from already exists

**MSS**
Expand All @@ -442,7 +444,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

**Use cases: UC06 - Undo an execution of command**
**Use case: UC06 - Undo an execution of command**
**Precondition**: At least one valid command has been executed by the user.

**MSS**
Expand All @@ -456,7 +458,7 @@ before the command was executed.
* 1a. No earlier data to revert.
* 1a1. CampusConnect shows error message.

Use cases ends.
Use case ends.

**Use Case: UC07 - Redo Command Execution**

Expand Down Expand Up @@ -491,7 +493,9 @@ before the command was executed.
* **Field**: An attribute possessed by a contact, namely Phone number, Tags, Name and Email.
* **Prefix**: An identifier used in commands to indicate which field is referred to. For the 4 fields Phone, Name, Tags and Email,
the *prefixes* would be `p/`, `t/`, `n/` and `e/` respectively.
* **Duplicate Contact**: A contact that has the same Phone, Email or Name as another contact.
* **Duplicate Contact**: A contact is considered a duplicate if it shares the same phone number, email, or name with another contact.
Phone numbers and emails are unique identifiers, so allowing duplicates could cause confusion, such as accidentally contacting the wrong person.
Unique names also help maintain organization, with small variations (e.g., capitalization or adding a number) used to distinguish individuals with the same name.
* **Tag List**: The scrollable list in the GUI displaying all unique tags and their colour-coded categories. The execution of `find` commands do not change the content of tag lists.
* **Person List**: The scrollable list of contacts in the GUI displaying all contacts and the respective values for their fields.
* **Commands affected by `undo` and `redo`**: These refer to all commands that affect the *state* of the Tag List and Contact List
Expand Down
5 changes: 5 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ any traditional point-and-click management app.

**Notes about duplicate contacts:**<br>
* A contact is considered a duplicate of another if it has the same Name, Phone or Email as the other contact.
*

**Notes about case sensitivity:**<br>
* Names, emails and tags are case-sensitive.
Expand Down Expand Up @@ -136,6 +137,8 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL [t/TAG]…​`

* The phone number must follow the Singaporean convention: have 8 digits, start with 6, 8, or 9, and consist only of numbers.
* Duplicate contacts cannot be added to the list.
* Names are case-sensitive. For example, “Alice” and “alice” are considered distinct names.
* Names should only contain alphanumeric characters and spaces, and it should not be blank.

Examples:
* `add n/John Doe p/98765432 e/[email protected]`
Expand Down Expand Up @@ -319,6 +322,8 @@ _Details coming soon ..._
**Q**: How do I transfer my data to another Computer?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous CampusConnect home folder.

**Q**: How can I add contacts with the same name?<br>
**A**: If two contacts share the same name, you can differentiate them by adding a number or adjusting the capitalization. For example, use “Mary” and “Mary 2” or “John” and “john” to keep each entry unique.
--------------------------------------------------------------------------------------------------------------------

## Known Issues
Expand Down

0 comments on commit f2b87e7

Please sign in to comment.