MatchMate Developer Guide

---

Acknowledgements

This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

---

Setting up, getting started

Refer to the guide Setting up and getting started.

---

Design

Architecture

The Architecture Diagram given above explains the high-level design of the App.

Given below is a quick overview of main components and how they interact with each other.

Main components of the architecture

Main (consisting of classes Main and MainApp) is in charge of the app launch and shut down.

• At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
• At shut down, it shuts down the other components and invokes cleanup methods where necessary.

The bulk of the app's work is done by the following four components:

• UI: The UI of the App.
• Logic: The command executor.
• Model: Holds the data of the App in memory.
• Storage: Reads data from, and writes data to, the hard disk.

Commons represents a collection of classes used by multiple other components.

How the architecture components interact with each other

The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command delete #1.

Each of the four main components (also shown in the diagram above),

• defines its API in an interface with the same name as the Component.
• implements its functionality using a concrete {Component Name}Manager class (which follows the corresponding API interface mentioned in the previous point).

For example, the Logic component defines its API in the Logic.java interface and implements its functionality using the LogicManager.java class which follows the Logic interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.

The sections below give more details of each component.

UI component

The API of this component is specified in Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, CourseMateListPanel, StatusBarFooter etc. All these, including the MainWindow, inherit from the abstract UiPart class which captures the commonalities between classes that represent parts of the visible GUI.

The UI component uses the JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

The UI component,

• executes user commands using the Logic component.
• listens for changes to Model data so that the UI can be updated with the modified data.
• keeps a reference to the Logic component, because the UI relies on the Logic to execute commands.
• depends on some classes in the Model component, as it displays CourseMate and Group objects residing in the Model.
• maintains the command history (in the CommandHistory class) and provides the command history to the user when requested.

Logic component

API : Logic.java

Here's a (partial) class diagram of the Logic component:

The sequence diagram below illustrates the interactions within the Logic component, taking execute("delete #1") API call as an example.

How the Logic component works:

1. When Logic is called upon to execute a command, it is passed to an MatchMateParser object which in turn creates a parser that matches the command (e.g., DeleteCommandParser) and uses it to parse the command.
2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager.
3. The command can communicate with the Model when it is executed (e.g. to delete a courseMate).
   Note that although this is shown as a single step in the diagram above (for simplicity), in the code it can take several interactions (between the command object and the Model) to achieve.
4. The result of the command execution is encapsulated as a CommandResult object which is returned back from Logic.

Here are the other classes in Logic (omitted from the class diagram above) that are used for parsing a user command:

How the parsing works:

• When called upon to parse a user command, the MatchMateParser class creates an XYZCommandParser (XYZ is a placeholder for the specific command name e.g., AddCommandParser) which uses the other classes shown above to parse the user command and create a XYZCommand object (e.g., AddCommand) which the MatchMateParser returns back as a Command object.
• All XYZCommandParser classes (e.g., AddCommandParser, DeleteCommandParser, ...) inherit from the Parser interface so that they can be treated similarly where possible e.g, during testing.

Model component

API : Model.java

The Model component,

• stores the contact data i.e., all CourseMate objects (which are contained in a UniqueCourseMateList object).
• stores the group data i.e., all Group objects (which are contained in a UniqueGroupList object).
• stores the currently 'selected' CourseMate or Group objects (e.g., results of a search query) as separate filtered lists which are exposed to outsiders as unmodifiable ObservableList<CourseMate> or ObservableList<Group> objects that can be 'observed' e.g. the UI can be bound to these lists so that the UI automatically updates when the data in the lists change.
• stores the currently selected CourseMate object (if any).
• stores a UserPref object that represents the user’s preferences. This is exposed to the outside as a ReadOnlyUserPref objects.
• does not depend on any of the other three components (as the Model represents data entities of the domain, they should make sense on their own without depending on other components)

Storage component

API : Storage.java

The Storage component,

• can save contact list data, group list data and user preference data in JSON format, and read them back into corresponding objects.
• inherits from ContactListStorage, GroupListStorage and UserPrefStorage, which means it can be treated as either one (if only the functionality of only one is needed).
• depends on some classes in the Model component (because the Storage component's job is to save/retrieve objects that belong to the Model)

Common classes

Classes used by multiple components are in the seedu.address.commons package.

---

Implementation

This section describes some noteworthy details on how certain features are implemented.

[UI] Coursemate Detail Panel

Implementation

The courseMate detail panel in the UI shows the details of a selected or recently processed courseMate. It is implemented in the CourseMateDetailPanel class.

The CourseMateDetailPanel class is mutable, the displayed courseMate can be change by calling the CourseMateDetailPanel#loadCourseMate(CourseMate) method.

The following shows the sequence diagrams of how the UI component loads the courseMates into the courseMate detail panel dynamically.

1. The user selects a courseMate from the courseMate list panel.

   

   The main window implements the functional interface CourseMateDetailPanel#CourseMateSelectHandler to reflect the selected courseMate in the courseMate detail panel and the Logic, which saves the selected courseMate in the Model used for future commands with the ## notation.

2. The user executes a command that modifies the selected courseMate.

   

   The CommandResult object returned by the Logic component contains a flag that indicates if the command involves one processed courseMate. If so, CourseMateDetailPanel is updated with the processed courseMate.

Two types of selection in the courseMate list panel are supported: double click and pressing the enter key. This requires two different event handlers to be implemented in the CourseMateListPanel class as shown below. These event handlers are instantiated and set as the event handlers for the ListView object in the constructor of CourseMateListPanel.

Alternatives Considered

• Alternative 1: The courseMate detail panel is immutable, and a new panel is created for each courseMate.
  • Pros: Easier to implement since the other UI components no longer have to keep a reference to the courseMate detail panel.
  • Cons: It makes it unclear that MainWindow and CourseMateDetailPanel have a one-to-one whole-part relationship.
• Alternative 2: Allow the courseMate list panel to directly update the courseMate detail panel.
  • Pros: Simplifies the code as the MainWindow no longer has to act as a middleman. The functional interface CourseMateDetailPanel#CourseMateSelectHandler can be removed.
  • Cons: The CourseMateListPanel and CourseMateDetailPanel are more tightly coupled. This increases maintenance costs.
• Alternative 3: Give full control to the Logic component to update the courseMate detail panel.
  • Pros: We no longer need to include an extra field in the CommandResult object to indicate if the command involves one processed courseMate.
  • Cons: The Logic component is now responsible for updating the UI, which is not ideal as the Logic component should not be aware of the UI's click and press events.

[Model & Storage] Groups

Implementation

A Group is a list of unique courseMates with a few extra metadata. Thus, it makes sense for it to inherit from UniqueCourseMateList.

A Group is given a unique case-sensitive name when constructed. It may also be given a set of unique Skill objects, unique member CourseMate objects, and an optional TelegramChat object.

CourseMate objects are kept unique by ensuring no two CourseMate objects have the same name, using the CourseMate::isSameCourseMate method. Skill and Name objects are kept unique using their respective equals methods.

A GroupList is also used to maintain the list of all unique groups created. The model manager maintains a single copy of this GroupList.

The GroupList object maintains a single copy of a UniqueGroupList, this class enforces uniqueness using Group::isSameGroup and also maintains an observable copy of the list for the UI.

Alternatives Considered

• Alternative 1: GroupList is a singleton class.
  • Pros: It makes sense that we only have a single GroupList at any one time in normal usage.
  • Cons: As with most singletons, it does make testing more difficult as different tests will have a harder time using different lists of groups.
• Alternative 2: Group does not inherit UniqueCourseMateList.
  • Pros: It isn't exactly clear-cut that Group is a UniqueCourseMateList, since UniqueCourseMateList is also used to display info to the UI through the observer pattern, causing potential for unneeded coupling.
  • Cons: It does make enough sense that a Group has most properties of a UniqueCourseMateList, using another class may also result in code duplication.
• Alternative 3: Group objects are given an ID instead of being kept unique through their names.
  • Pros: It allows for multiple Group objects to have the same name, and an ID makes more sense conceptually to differentiate objects than a Name.
  • Cons: It is not clear that multiple Group objects should be allowed to have the same name, it may also be harder to uniquely refer to groups in the app if you have to use an ID to differentiate.

---

Documentation, logging, testing, configuration, dev-ops

• Documentation guide
• Testing guide
• Logging guide
• Configuration guide
• DevOps guide

---

Appendix: Requirements

Product scope

Target user profile:

John is a NUS computer science student taking various courses with a group project component. He wishes to create groups among his friends / acquaintances and find balanced groups with diverse skillsets out of his own contact list.

Value proposition:

To allow students to find balanced groups with diverse skillsets out of their own contact list.

User stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Use cases

(For all use cases below, the System is MatchMate and the Actor is the user, unless specified otherwise)

Use case: UC01 - Get help on commands

MSS

1. User requests for help.

2. MatchMate returns a link to the user guide.

   Use case ends.

Use case: UC02 - Add a new courseMate

MSS

1. User requests to add a new courseMate along with the data.

2. MatchMate adds the courseMate to the list.

3. MatchMate shows the updated list of courseMate.

   Use case ends.

Extensions

• 1a. User inputs invalid or incomplete data.

  • 1a1. MatchMate shows a message indicating the data is invalid or incomplete.

    Use case resumes at step 1.

Use case: UC03 - Delete a courseMate

MSS

1. User requests to delete a courseMate.

2. MatchMate deletes the courseMate.

   Use case ends.

Extensions

• 1a. User inputs a courseMate that does not exist.

  • 1a1. MatchMate shows a message indicating the courseMate cannot be found.

    Use case resumes at step 1.

• 1b. User inputs a name of which multiple courseMates have the specified name as a substring.

  • 1b1. MatchMate filters and lists the courseMates that has the name.

    Use case resumes at step 1.

Use case: UC04 - List all courseMates

MSS

1. User requests to list all courseMates.

2. MatchMate shows all courseMates.

   Use case ends.

Use case: UC05 - Filter courseMates based on keyword

MSS

1. User requests to find courseMates with the specified keyword.

2. MatchMate shows a list of the filtered courseMate.

   Use case ends.

Use case: UC06 - Edit a courseMate

MSS

1. User requests to edit a courseMate along with the new data.

2. MatchMate edits the courseMate's respective fields.

3. MatchMate shows the updated list of courseMates.

   Use case ends.

Extensions

• 1a. User requests to edit a courseMate that does not exist.

  • 1a1. MatchMate shows a message indicating that the courseMate cannot be found.

    Use case resumes at step 1.

• 1b. User inputs invalid or incomplete data.

  • 1b1. MatchMate shows a message indicating that the data is invalid or incomplete.

    Use case resumes at step 1.

• 1c. User inputs a name of which multiple courseMates have the specified name as a substring.

  • 1c1. MatchMate filters and lists the courseMates that has the name.

    Use case resumes at step 1.

Use case: UC07 - Add skills to a courseMate

MSS

1. User requests to add skills to a courseMate.

2. MatchMate appends the skills to the courseMate.

3. MatchMate shows the updated list of courseMates.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a courseMate that does not exist.

  • 1b1. MatchMate shows a message indicating the courseMate cannot be found.

    Use case resumes at step 1.

• 1c. User inputs a skill that does not exist yet.

  • 1c1. MatchMate shows a warning message indicating the skill is a new entry.

    Use case ends.

• 1d. User inputs a name of which multiple courseMates have the specified name as a substring.

  • 1d1. MatchMate filters and lists the courseMates that has the name.

    Use case resumes at step 1.

Use case: UC08 - Delete skills from a courseMate

MSS

1. User requests to delete existing skills from a courseMate.

2. MatchMate removes the specified skills from the courseMate.

3. MatchMate shows the updated list of courseMates.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a courseMate that does not exist.

  • 1b1. MatchMate shows a message indicating the courseMate cannot be found.

    Use case resumes at step 1.

• 1c. User inputs a skill the courseMate does not have.

  • 1c1. MatchMate shows a message indicating the skill cannot be found.

    Use case resumes at step 1.

• 1d. User inputs a name of which multiple courseMates have the specified name as a substring.

  • 1d1. MatchMate filters and lists the courseMates that has the name.

    Use case resumes at step 1.

Use case: UC09 - Create a group

MSS

1. User requests to create a group with a specified name.

2. MatchMate acknowledges the creation of the group.

   Use case ends.

Extensions

• 1a. User inputs a group name that already exists.

  • 1a1. MatchMate shows a message indicating the group already exists.

    Use case resumes at step 1.

Use case: UC10 - Delete a group

MSS

1. User requests to delete a group.

2. MatchMate deletes the group.

   Use case ends.

Extensions

• 1a. User inputs a group that does not exist.

  • 1a1. MatchMate shows a message indicating the group cannot be found.

    Use case resumes at step 1.

Use case: UC11 - Add a courseMate to a group

MSS

1. User requests to add a courseMate to a group by specifying the group's name.

2. MatchMate adds the courseMate to the group.

3. MatchMate shows the updated list of courseMates in the specified group.

   Use case ends.

Extensions

• 1a. User inputs a name or index no courseMates correspond to.

  • 1a1. MatchMate shows a message indicating the courseMate doesn't exist.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. User inputs a name of which multiple courseMates have the specified name as a substring.

  • 1c1. MatchMate filters and lists the courseMates that has the name.

    Use case resumes at step 1.

• 1d. The courseMate is already in the group.

  • 1d1. MatchMate shows a message indicating the courseMate is already in the group.

    Use case resumes at step 1.

Use case: UC12 - Remove a courseMate from a group

MSS

1. User requests to remove a courseMate to a group by specifying the group's name.

2. MatchMate removes the courseMate to the group.

3. MatchMate shows the updated list of courseMates in the specified group.

   Use case ends.

Extensions

• 1a. User inputs a name or index no courseMates correspond to.

  • 1a1. MatchMate shows a message indicating the courseMate doesn't exist.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. User inputs a name of which multiple courseMates have the specified name as a substring.

  • 1c1. MatchMate filters and lists the courseMates that has the name.

    Use case resumes at step 1.

• 1d. The courseMate is not in the group.

  • 1d1. MatchMate shows a message indicating the courseMate is not in the group.

    Use case resumes at step 1.

Use case: UC13 - Edit telegram chat URL for group

MSS

1. User requests to edit the telegram chat of a group by specifying the group's name.

2. MatchMate edits the telegram chat URL of the group.

3. MatchMate shows the updated group.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. User inputs a telegram chat URL with an invalid syntax.

  • 1c1. MatchMate shows a message indicating the telegram chat URL is invalid.

    Use case resumes at step 1.

Use case: UC14 - Filter groups based on keyword

MSS

1. User requests to find groups with the specified keyword.

2. MatchMate shows a list of the filtered groups.

   Use case ends.

Use case: UC15 - Add skills required for the group

MSS

1. User requests to set skills required by the group that is specified by the group's name.

2. MatchMate adds the required skills to the group.

3. MatchMate shows the updated group.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. User inputs a skill that does not exist yet.

  • 1c1. MatchMate shows a warning message indicating the skill is a new entry.

    Use case ends.

Use case: UC16 - Remove skills that were required for the group

MSS

1. User requests to remove skills required by the group that is specified by the group's name.

2. MatchMate removes the required skills from the group.

3. MatchMate shows the updated group.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. User inputs a skill that is not in the group's list of required skills.

  • 1c1. MatchMate shows a message indicating the skill cannot be found.

    Use case resumes at step 1.

Use case: UC17 - Mark required skills of a group as important

MSS

1. User requests to mark required skills of a group as important. The group is specified by the group's name.

2. MatchMate marks the required skills requested as important.

3. MatchMate shows the updated group.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. User inputs a skill that is not in the group's list of required skills.

  • 1c1. MatchMate shows a message indicating the skill cannot be found.

    Use case resumes at step 1.

Use case: UC18 - Unmark required skills' importance of a group

MSS

1. User requests to unmark required skills' importance of a group. The group is specified by the group's name.

2. MatchMate unmarks the required skills requested as important.

3. MatchMate shows the updated group.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. User inputs a skill that is not in the group's list of required skills.

  • 1c1. MatchMate shows a message indicating the skill cannot be found.

    Use case resumes at step 1.

Use case: UC19 - Suggests mates for a group

MSS

1. User requests to suggest courseMates for a group specified by the group's name.

2. MatchMate filters the courseMate list based on the required skills not satisfied in the group.

3. MatchMate shows the updated list of courseMates.

   Use case ends.

Extensions

• 1a. User inputs incomplete data.

  • 1a1. MatchMate shows a message indicating incomplete data.

    Use case resumes at step 1.

• 1b. User inputs a group name that doesn't exist.

  • 1b1. MatchMate shows a message indicating the group doesn't exist.

    Use case resumes at step 1.

• 1c. All of the required skills in the group are already covered.

  • 1c1. MatchMate shows a message indicating all required skills are fulfilled.

    Use case ends.

Use case: UC20 - Give a rating for a courseMate

MSS

1. User requests to give a rating to a courseMate specified by a name or an index.

2. MatchMate adds the courseMate's rating.

3. MatchMate shows the updated list of courseMates.

   Use case ends.

Extensions

• 1a. User requests to edit a courseMate that does not exist.

  • 1a1. MatchMate shows a message indicating the courseMate cannot be found.

    Use case resumes at step 1.

• 1b. User inputs invalid or incomplete data.

  • 1b1. MatchMate shows a message indicating the data is invalid or incomplete.

    Use case resumes at step 1.

• 1c. User inputs a name of which multiple courseMates have the specified name as a substring.

  • 1c1. MatchMate filters and lists the courseMates that has the name.

    Use case resumes at step 1.

• 1d. User provides an invalid rating

  • 1d1. MatchMate shows a message indicating the rating is invalid.

    Use case resumes at step 1.

Use case: UC21 - Exit the application

MSS

1. User requests to exit the program.

2. MatchMate terminates the program.

   Use case ends.

Non-Functional Requirements

1. Environment: Should work on any mainstream OS as long as it has Java 11 or above installed.
2. Performance: Should respond to user interaction within 3 seconds at most for typical usage (unless it is lagging due to reasons external to the app).
3. Performance: Should be able to hold up to 100 courseMates without a noticeable sluggishness in performance (as specified above) for typical usage.
4. Resilience: Should gracefully handle commonly anticipated errors (e.g. incorrect command input) without crashing or losing saved data.
5. Accessibility: Should inform the user with a help message if a command has failed due to incorrect user input.
6. Accessibility: Usage of basic commands (e.g. add, edit) should be learnable within a day.
7. Accessibility: A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.

Glossary

• Mainstream OS: Windows, Linux, Unix, MacOS
• Command: A user input that will cause the application to perform an operation according to the UserGuide
• CourseMate: A friend or classmate that you expect to form a group based on certain skills they may have
• Group: A grouping/team of courseMates for a course, project, or activity
• Skill: Knowledge, ability, or experience that a courseMate has

---

Appendix: Planned Enhancements

Team size: 5

1. Creating an edit group command: Currently, the user can only edit the group name of a project group by deleting the group and re-creating it. All information in the group will be cleared after that. We plan to implement an edit group command that allows the user to edit the group name without losing the information in the group, by supplying the original group name and the new group name.

2. Improved filtering when adding or removing members in a group with similar names: When trying to add or remove a member from a group using a substring of the member's name, the app currently lists all courseMates with the substring in their name, regardless of whether they are already in the group. This causes the user having to re-try the command using the hashtag notation unnecessarily. We plan to enhance this filtering by excluding members that are already in the group for the add-member command, and excluding members that are not in the group for the remove-member command.

3. Provide warnings for require-skill when skill is already required: Currently, the app does not provide any feedback when a user tries to require a skill that is already required. We plan to provide a warning message in such cases to inform the user that the command has no effect, and suggest the user to check for typos.

4. Display error messages for unrequire-skill when skill is not yet required: Currently, if the user tries to unrequire a skill that is not yet required, the app only shows a warning message and proceeds to unrequire the other skills supplied. This is inconsistent with the behaviour of the commands mark-important and unmark-important. We plan to reject the entire command if the user tries to unrequire a skill that is not yet required, and show an error message to inform the user that one or more of the skills are not yet required.

5. Provide warnings for mark-important and unmark-important when skill is already marked / unmarked as important: Currently, the app does not provide any feedback when a user tries to mark a skill as important that is already marked as important, or unmark a skill that is already unmarked. We plan to provide a warning message in such cases to inform the user that the command has no effect, and suggest the user to check for typos.

6. Provide warnings for add-skill and delete-skill when skill is already added / deleted: Currently, the app does not provide any feedback when a user tries to add a skill that is already added, or delete a skill that is already deleted. We plan to provide a warning message in such cases to inform the user that the command has no effect, and suggest the user to check for typos.

7. Allow case-insensitive command names: Currently, the app only recognizes command names in lowercase. We plan to allow users to enter the command names in any case (e.g. Add, aDd, ADD), and the app will recognize them as the same command.

---

Appendix: Instructions for manual testing

Given below are instructions to test the app manually.

Launch and shutdown

1. Initial launch

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

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

2. Saving window preferences

   1. Resize the window to an optimum size. Move the window to a different location. Close the window.

   2. Re-launch the app by double-clicking the jar file.
      Expected: The most recent window size and location is retained.

3. To quit and shut down the app, either type exit, or click on the x button on the top right corner.

Adding a courseMate

1. Prerequisite: The MatchMate app has been launched.

2. Test case: add Ivan -e ivan@gmail.com -p 9427318 -s C++
   Expected: Successfully adds ivan with the corresponding email, phone number, and skill

3. Test case: add Benson -e benson@gmail.com
   Expected: Successfully adds Benson with his email. Phone number and skills are optional fields.

Editing a courseMate

1. Prerequisites: You have added Benson and Ivan into your courseMate list, by following the commands in the previous section.

2. Test case: edit #1 -n Alex
   Expected: Edits the first courseMate's name to Alex

3. Test case: edit Ivan -n Ivan Tan
   Expected: Edits Ivan's name to Ivan Tan

4. Test case: edit Ben -n Benson CS
   Expected: Edits Benson's name to Benson CS. Edit utilizes substring search, and because there's only 1 courseMate with "Ben" as its name's substring, thus Benson's name gets updated to Benson CS.

Adding a skill to a courseMate

1. Prerequisites: You have added Benson and Ivan into your courseMate list, by following the commands in the previous section.

2. Test case: add-skill Ivan Tan -s C++
   Expected: Adds C++ skill to Ivan Tan

3. Test case: add-skill Ivan Tan -s React
   Expected: Adds React skill to Ivan Tan, and also gives a warning that if one or more skils added have not been previously added to other courseMates. This error message serves to warn for any potential typos when adding skills

4. Test case: add-skill Benson CS -s JS -s SQL
   Expected: Adds JS and SQL skills to Benson, and also gives a warning that if one or more skils added have not been previously added to other courseMates. This error message serves to warn for any potential typos when adding skills

Deleting a skill from a courseMate

1. Prerequisites: You have added C++ and React skills to Ivan as well as JS and SQL skills to Benson, by following the commands in the previous section.

2. Test case: delete-skill Ivan Tan -s React
   Expected: React skill is deleted from Ivan Tan

3. Test case: delete-skill Benson CS -s JS -s SQL
   Expected: JS and SQL skills are deleted from Benson

Search courseMates with keywords

1. Prerequisites: You are using the preloaded data, and have only added two new courseMates, Ivan Tan and Benson CS.

2. Test case: find-mate Ivan
   Expected: Finds Ivan Tan in the courseMate list

3. Test case: find-mate a
   Expected: Finds all courseMates whose names/skills contain a

4. Test case: find-mate C++
   Expected: Finds all courseMates whose names/skills contain C++

Deleting a courseMate

1. Prerequisites: List all courseMates using the list command. Multiple courseMates in the list.

2. Test case: delete #1
   Expected: First courseMate is deleted from the list. Details of the deleted courseMate shown in the status message.

3. Test case: delete #0
   Expected: No courseMate is deleted. Error details shown in the status message.

4. Other incorrect delete commands to try: delete, delete #x (where x is larger than the list size), ...
   Expected: Similar to previous.

Rate a courseMate

1. Prerequisites: You are using the preloaded data, and have only added two new courseMates, Ivan Tan and Benson CS.

2. Test case: rate-mate Ivan Tan -r 4
   Expected: Shows 4 stars out of 5 on Ivan's courseMate card.

3. Test case: rate-mate Benson CS -r 6
   Expected: Shows an error message saying that ratings can only be between 0 and 5.

Creating a group

1. Prerequisites: You are using the preloaded data, and have only added two new courseMates, Ivan Tan and Benson CS.

2. Test case: create-group CS project -cm Ivan -t https://t.me/+WDTg34uuUlH8Ml2d -s C++
   Expected: Creates a group called CS project, with Ivan as one of its group members. Also adds a telegram link for the group, and adds C++ as a skill required in the group. The skill C++ is marked green as one of its members, Ivan, has C++ as one of his skills.

3. Test case: create-group ES2660 -cm Benson -s Leadership
   Expected: Creates a group called ES 2660, with Benson as one of its group members. Also adds a Leadership as a skill required in the group. A warning is also given as leadership is not a skill that has been added anywhere. The skill Leadership is red as its only member, as Benson does not have Leadership skill

Adding courseMates to a group

1. Prerequisites: You have followed all the steps along and added two new courseMates Ivan and Benson, as well as created two new groups "CS project" and "ES2660"

2. Test case: add-skill Ivan -s Leadership then add-member ES2660 -cm Ivan
   Expected: The first command adds a skill called Leadership to Ivan, then add Ivan to the ES2660 group. As a result, the Leadership skill in ES2660 turns to green as one of its group members has that skill

Deleting courseMates from a group

1. Prerequisites: You have followed all the steps along and added Ivan and Benson to the corresponding groups "CS project" and "ES2660"

2. Test case: delete-member ES2660 -cm Ivan
   Expected: Deletes Ivan from the ES2660 group. This causes the skill Leadership to go back to red as it has not been fulfilled.

3. Test case: delete-member CS project -cm Benson
   Expected: The command fails as Benson is not in the CS project group. Relevant error message is displayed

Edit group telegram url

1. Prerequisites: You have added the groups "CS project" and "ES2660"

2. Test case: edit-tg-chat-url ES2660 -t https://t.me/+HWasdo2831Uasodi
   Expected: Creates a telegram group chat link for ES2660

3. Test case: edit-tg-chat-url ES2660 -t https://+HWasdo2831Uasodi
   Expected: The command fails as the url given is not a telegram link. Relevant error message is displayed

Require skills in a group

1. Prerequisites: You have added the groups "CS project" and "ES2660"

2. Test case: require-skill ES2660 -s Presentation
   Expected: Adds a new required skill for ES2660. Also gives a warning as Presentation is a skill that has not been added anywhere before.

Unrequire skills in a group

1. Prerequisites: You have added the groups "CS project" and "ES2660", as well as added C++ skill for CS project as well as Leadership and Presentation skills for ES2660

2. Test case: unrequire-skill ES2660 -s Presentation
   Expected: Removes Presentation skill from ES2660

3. Test case: unrequire-skill CS project -s Java
   Expected: Java is not a required skill in CS project. The command does nothing and a relevant warning message is displayed

Mark important skills in a group

1. Prerequisites: You have added the groups "CS project" and "ES2660", and CS project requires C++ skill while ES2660 requires Leadership skill

2. Test case: mark-important ES2660 -s Leadership
   Expected: Shows an exclamation mark besides the Leadership skill signifying that it is important

3. Test case: mark-important CS project -s Java
   Expected: The command fails as Java is not a required skill in CS project. Relevant error message is displayed

Unmark important skills in a group

1. Prerequisites: You have added the groups "CS project" and "ES2660", and CS project requires C++ skill while ES2660 requires Leadership skill

2. Test case: unmark-important ES2660 -s Leadership
   Expected: Removes the exclamation mark besides the Leadership skill

Suggest courseMates for group

1. Prerequisites: You have added the groups "CS project" and "ES2660", and CS project requires C++ skill while ES2660 requires Leadership skill. Ivan is in the CS project group and Benson is in the ES2660 group.

2. Test case: suggest-mate CS project
   Expected: Gives a message saying "All required skills have already been fulfilled. Consider adding what skills you're looking for?"

3. Test case: suggest-mate ES2660
   Expected: Shows Ivan Tan as the only courseMate that has the Leadership skill.

Search groups with keywords

1. Prerequisites: You are using the preloaded data and have added the groups "CS project" and "ES2660"

2. Test case: find-group CS
   Expected: Shows 3 groups: CS2103T, CS2101, CS Project as 3 of them contains CS in the group name

Delete a group

1. Prerequisites: You are using the preloaded data and have added the groups "CS project" and "ES2660"

2. Test case: delete-group ES2660
   Expected: Deletes the group ES2660