Skip to content

Commit

Permalink
Resolve merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
ylyma committed Nov 11, 2023
2 parents 3006f94 + 9cefad2 commit 2ee6dbb
Show file tree
Hide file tree
Showing 16 changed files with 196 additions and 75 deletions.
74 changes: 35 additions & 39 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Introducing **TAfinder - the one-stop solution for all your TA selection needs**
With TAfinder, you can easily:
1. **Manage** troves of TA applicants.
2. Make more **informed decisions** with the help of our **compare** and **sort** functions.
3. **Import** and **export** data to and from the TAfinder application.
3. **Import** data to the TAfinder application.

TAfinder utilises a Command Line Interface (CLI), while still enjoying the benefits of a Graphical User Interface (GUI),
for a more efficient user experience.
Expand Down Expand Up @@ -61,7 +61,7 @@ You can click on any of the links below to navigate to the respective sections f
- [7.2. Command Summary](#7-2-command-summary)
- [7.2.1. Basic applicant management commands](#7-2-1-basic-applicant-management-commands)
- [7.2.2. Applicant comparison and evaluation commands](#7-2-2-applicant-comparison-and-evaluation-commands)
- [7.2.3. Data management and export commands](#7-2-3-data-management-and-export-commands)
- [7.2.3. Data management commands](#7-2-3-data-management-commands)

--------------------------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -220,7 +220,7 @@ lines as space characters surrounding line-breaks may be omitted when copied ove

#### 2.1.1. Adding an applicant: `add`

You have just finished setting up TAfinder and you are ready to add your first applicant.
You have just finished setting up TAfinder and you are ready to add your first applicant.
Let's find out how you can add the applicant to the list.

**Format:**
Expand Down Expand Up @@ -293,8 +293,8 @@ watch out for the expected and erroneous messages below that could be displayed

<box type="success" light>

Successfully added applicant and his/her information:<br>
**`"New applicant added: Student number: <student number>; Name: <name>; Phone: <phone>;
Successfully added applicant and the applicant's information:<br>
**`"New applicant added: Student number: <student number>; Name: <name>; Phone: <phone>;
Email: <email>; GPA: <gpa>; Previous grade: <previous grade>; [Interview score: <interview score>];
[Comment: <comment>]; [Tags: <tags>]."`**

Expand All @@ -310,7 +310,7 @@ Email: <email>; GPA: <gpa>; Previous grade: <previous grade>; [Interview score:

Invalid command format:<br>
**`"Invalid command format!"`<br>
`"add: Adds an applicant to the list. Parameters: s/STUDENT NUMBER n/NAME p/PHONE e/EMAIL g/GPA pg/PREV GRADE
`"add: Adds an applicant to the list. Parameters: s/STUDENT NUMBER n/NAME p/PHONE e/EMAIL g/GPA pg/PREV GRADE
[is/INTERVIEW SCORE] [c/COMMENT] [t/TAG]..."`<br>
`"Example: add s/A0343434C n/John Doe p/98765432 e/[email protected] g/4.9 pg/A is/9.1 c/Hardworking and diligent t/pastTA "`**

Expand Down Expand Up @@ -430,7 +430,7 @@ Index out of range:<br>
#### 2.1.3. Deleting an applicant: `delete`
<box type="definition">

Delete an existing applicant in the list of applicants.
Delete a singular existing applicant in the list of applicants.

</box>

Expand Down Expand Up @@ -598,7 +598,7 @@ Displays a single applicant.

<box type="success" light>

Successfully displaying all details of an applicant in the following format:\
Successfully displaying all details of an applicant in the following format:
- **`Name: John Doe`**
- **`Student number: A0358289S`**
- **`Phone Number: 91234567`**
Expand Down Expand Up @@ -988,70 +988,66 @@ Index out of range:<br>

#### 2.2.6. Commenting on TA applicant: **`comment`**


<box type="definition">

Add comments on a specific applicant

</box>

![commentUI.jpg](images/comment_afterUI.png)

<box type="info">
One of yours TAs is unable to make it for the interview.
You want to make a comment on the applicant to remind yourself to follow up with him/her.
Lets find out how to do use the comment feature to do so.

**Format:**

**`comment INDEX c/COMMENT`**

<box no-icon type="info" light>
<box no-icon type="info" seamless>

**`INDEX`**: The index corresponding to the applicant to be commented. The index must be a positive integer (e.g., 1, 2, 3…).

</box>

<box no-icon type="info" light>
<box type="tip">

**`COMMENT`:** The comment to be made about the applicant.
The index of the applicant is the number beside the applicant's name in the list of applicants.

</box>

</box>
**Examples:**

<box type="info" theme="dark">
<box type="default" seamless>

**Example:**
**`comment 3 c/Unable to make it for interview`**
- Comments on the third applicant with the comment: "Unable to make it for interview"

<box type="default" light>
</box>

**`comment 3 c/Hardworking and studious`**
- Comments on the third applicant with the comment: "Hardworking and studious"
Following the example above, if you entered everything correctly, you should see the following:

</box>
![commentUI.jpg](images/comment_afterUI.png)

</box>
You have now successfully commented on the applicant. As you comment on more applicants in the list,
watch out for the expected and erroneous messages below that could be displayed in the command result screen!

<box type="success">
<box no-icon type="success">

**Expected outputs:**
**Expected Outputs:**

<box type="success" light>

- Successfully commenting on the applicant at the corresponding index.
- Confirmation message:<br>
Successfully commenting on the applicant at the corresponding index.<br>
**`"Applicant at index INDEX has been successfully commented on."`**

</box>

</box>

<box type="wrong">
<box no-icon type="wrong">

**Errors:**
**Erroneous Outputs:**

<box type="wrong" light>

Missing index:<br>
**`“Error: Missing index. Please follow the format: 'view INDEX'.”`**
Invalid command format:<br>
**`“Invalid command format!"`<br>
`"comment: Edits the comment of the person identified by the index number used in the last person listing. Existing comment will be overwritten by the input."`<br>
`"Parameters: INDEX (must be a positive integer) c/ [COMMENT]"`<br>
`"Example: comment 1 c/ Hardworking student”`**

</box>

Expand Down Expand Up @@ -1288,8 +1284,8 @@ If your changes to the data file makes its format invalid, TAfinder will discard
| **Comment** | - `comment INDEX COMMENT`<br/> - e.g., `comment 3 Hardworking` |


#### 7.2.3. Data management and export commands
#### 7.2.3. Data management commands
| Action | Format, Examples |
|-------------------------|-----------------------------------------------------------------|
| **Export** | - `export FILENAME`<br/> - e.g., `export ta-applicants.csv` |
| **Import** | - `import FILENAME`<br/> - e.g., `import ta-applicants.csv` |
| **Attach** | - `attach INDEX FILEPATH`<br> - e.g.,`attach 2 john-resume.pdf` |
Binary file modified docs/images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 11 additions & 4 deletions docs/team/lheng1.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,25 @@ TAfinder is a desktop resource management application used by NUS SOC professors

* **Enhancements implemented**:
* Enhancement 1: Compare between two applicants
* What it does (How deep the enhancement is):
* Justification (Why it is complete):
* Highlights (How hard was it to implement):
* Credits (If any):
* What it does (How deep the enhancement is): The enhancement facilitates a side-by-side comparison of two applicants through a user interface (UI).
* Description (What is the enhancement doing): The UI displays comprehensive details of both applicants, including Student Number, Name, GPA, Interview Score, Previous Module Grade, and Comments. The window intelligently compares values (e.g., GPA, Interview Score, Previous Module Grade) and highlights the higher score for quick reference. This feature streamlines the decision-making process for selecting a Teaching Assistant (TA).
* Justification (Why it is complete): The implemented feature offers a holistic view of applicants' credentials and simplifies the decision-making process by highlighting superior scores. This ensures that the professor can easily discern which applicant excels in specific criteria.
* Highlights (How hard was it to implement): Creating the UI posed challenges, particularly in integrating it with the main window. Ultimately, a separate window was developed to pop up upon the execution of the compare command.
* Credits (If any): Special thanks to Ravern for inspiring the idea of utilizing a separate window.

* **Contributions to the UG**:
* Which sections did you contribute to the UG?
* Created the skeletal version of the UG for the team.

* **Contributions to the DG**:
* Which sections did you contribute to the DG? Which UML diagrams did you add/updated?
* Created the compare command section under implementation.
* Created example use cases for the team.
* Created the user stories table.

* **Contributions to team-based tasks**:
* Created demos for the milestones.
* Created labels and milestones in team GitHub page.

* **Review/mentoring contributions**:
* Links to PRs reviewed, instances of helping team members in other ways.
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/logic/Messages.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
*/
public class Messages {

public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command";
public static final String MESSAGE_UNKNOWN_COMMAND = "Unknown command.";
public static final String MESSAGE_INVALID_COMMAND_FORMAT = "Invalid command format! \n%1$s";
public static final String MESSAGE_INVALID_PERSON_DISPLAYED_INDEX = "Error: Invalid index. "
+ "Please enter an index within range.";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package seedu.address.logic.commands;

import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
import static seedu.address.logic.parser.CliSyntax.PREFIX_COMMENT;
import static seedu.address.model.Model.PREDICATE_SHOW_ALL_PERSONS;

import java.util.List;
Expand All @@ -26,9 +27,9 @@ public class CommentCommand extends Command {
+ "Parameters: INDEX (must be a positive integer) "
+ "c/ [COMMENT]\n"
+ "Example: " + COMMAND_WORD + " 1 "
+ "c/ Hardworking student";
+ PREFIX_COMMENT + "Hardworking student";

public static final String MESSAGE_ADD_COMMENT_SUCCESS = "Added comment to Person: %1$s";
public static final String MESSAGE_ADD_COMMENT_SUCCESS = "Applicant has been successfully commented on.";
public static final String MESSAGE_DELETE_COMMENT_SUCCESS = "Removed comment from Person: %1$s.";

private final Index index;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
import seedu.address.logic.commands.DeleteCommand;
import seedu.address.logic.commands.EditCommand;
import seedu.address.logic.commands.ExitCommand;
import seedu.address.logic.commands.FindCommand;
import seedu.address.logic.commands.HelpCommand;
import seedu.address.logic.commands.HideCommand;
import seedu.address.logic.commands.ImportCommand;
Expand Down Expand Up @@ -77,9 +76,6 @@ public Command parseCommand(String userInput) throws ParseException {
case ClearCommand.COMMAND_WORD:
return new ClearCommand();

case FindCommand.COMMAND_WORD:
return new FindCommandParser().parse(arguments);

case AttachCommand.COMMAND_WORD:
return new AttachCommandParser().parse(arguments);

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/ui/HelpWindow.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/
public class HelpWindow extends UiPart<Stage> {

public static final String USERGUIDE_URL = "https://se-education.org/addressbook-level3/UserGuide.html";
public static final String USERGUIDE_URL = "https://ay2324s1-cs2103t-w10-1.github.io/tp/UserGuide.html";
public static final String HELP_MESSAGE = "Refer to the user guide: " + USERGUIDE_URL;

private static final Logger logger = LogsCenter.getLogger(HelpWindow.class);
Expand Down
6 changes: 0 additions & 6 deletions src/main/java/seedu/address/ui/PersonDetailContent.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

import javafx.fxml.FXML;
import javafx.scene.control.Label;
import javafx.scene.image.Image;
import javafx.scene.layout.FlowPane;
import javafx.scene.layout.HBox;
import javafx.scene.layout.Region;
Expand All @@ -17,11 +16,6 @@ public class PersonDetailContent extends UiPart<Region> {

private static final String FXML = "PersonDetailContent.fxml";

private static final Image BOOKMARKED = new Image(
PersonDetailContent.class.getResourceAsStream("/images/bookmarked.png"));
private static final Image NOT_BOOKMARKED = new Image(
PersonDetailContent.class.getResourceAsStream("/images/unbookmarked.png"));

/**
* Note: Certain keywords such as "location" and "resources" are reserved
* keywords in JavaFX.
Expand Down
8 changes: 4 additions & 4 deletions src/main/resources/view/CompareWindow.fxml
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
<Label fx:id="moduleGradeLabel1" alignment="CENTER" contentDisplay="CENTER" prefHeight="29.0" prefWidth="100.0" text="Comments" textAlignment="CENTER" textFill="WHITE" GridPane.columnIndex="1" GridPane.rowIndex="5" />
<Label fx:id="person1Comment" alignment="CENTER" prefHeight="23.0" prefWidth="159.0" textAlignment="CENTER" textFill="WHITE" GridPane.rowIndex="5" />
<Label fx:id="person2Comment" alignment="CENTER" prefHeight="23.0" prefWidth="79.0" textAlignment="CENTER" textFill="WHITE" GridPane.columnIndex="2" GridPane.rowIndex="5" />
<Rectangle fx:id="IScore1Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.rowIndex="3" />
<Rectangle fx:id="IScore2Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.columnIndex="2" GridPane.rowIndex="3" />
<Rectangle fx:id="MGrade1Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.rowIndex="4" />
<Rectangle fx:id="MGrade2Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.columnIndex="2" GridPane.rowIndex="4" />
<Rectangle fx:id="iScore1Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.rowIndex="3" />
<Rectangle fx:id="iScore2Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.columnIndex="2" GridPane.rowIndex="3" />
<Rectangle fx:id="mGrade1Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.rowIndex="4" />
<Rectangle fx:id="mGrade2Highlight" arcHeight="5.0" arcWidth="5.0" fill="#ffe100" height="25.0" opacity="0.0" stroke="WHITE" strokeType="INSIDE" width="80.0" GridPane.columnIndex="2" GridPane.rowIndex="4" />
<columnConstraints>
<ColumnConstraints prefWidth="80.0" />
<ColumnConstraints prefWidth="100.0" />
Expand Down
5 changes: 5 additions & 0 deletions src/test/data/ImportCommandTest/invalid.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name,phone,email,gpa,tags,studentNo,previousGrade
Jasmine David,9847283,[email protected],4.3,deansList;pastTA,A0123486A,D-
Sandeep Kopparthi,8753746,[email protected],5.0,pastTA,A0456123A,C-
Lim Boon Kong,9777777,[email protected],3.5.2,deansList,A0775848D,C
Mohammed Taufiq bin Rozaini,85535252,taufiqu.nus.edu,4.2,,A0483910A,A+
Empty file.
5 changes: 5 additions & 0 deletions src/test/data/ImportCommandTest/missing_fields.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
studentNo,name,phone,email,gpaa,previousGrade,tags
A0123486A,Jasmine David,98472983,[email protected],4.3,B+,deansList;pastTA
A0456123A,Sandeep Kopparthi,86753746,[email protected],5.0,B+,pastTA
A0775848D,Lim Boon Kong,97777777,[email protected],3.5,C,deansList
A0483910A,Mohammed Taufiq bin Rozaini,85535252,[email protected],4.2,A+,
5 changes: 5 additions & 0 deletions src/test/data/ImportCommandTest/partial_valid.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name,phone,email,gpa,tags,studentNo,previousGrade
Jasmine David,9847283,[email protected],4.3,deansList;pastTA,A0123486A,D-
Sandeep Kopparthi,8753746,[email protected],5.0,pastTA,A0456123A,C-
Lim Boon Kong,97777777,[email protected],3.5,deansList,A0775848D,C
Mohammed Taufiq bin Rozaini,85535252,[email protected],4.2,,A0483910A,A+
5 changes: 5 additions & 0 deletions src/test/data/ImportCommandTest/valid.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
studentNo,name,phone,email,gpa,previousGrade,tags
A0123486A,Jasmine David,98472983,[email protected],4.3,B+,deansList;pastTA
A0456123A,Sandeep Kopparthi,86753746,[email protected],5.0,B+,pastTA
A0775848D,Lim Boon Kong,97777777,[email protected],3.5,C,deansList
A0483910A,Mohammed Taufiq bin Rozaini,85535252,[email protected],4.2,A+,
Loading

0 comments on commit 2ee6dbb

Please sign in to comment.