Skip to content

Commit

Permalink
Merge pull request #32 from leeweiming3/update-UserGuide-tagstatus
Browse files Browse the repository at this point in the history
Update user guide, adding tag,status
  • Loading branch information
chiralcentre authored Feb 28, 2024
2 parents 81fc9e8 + 2e6c3bc commit b52d664
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,41 @@ Examples:
* `search n/John s/ACCEPTED` returns candidates whose names contain `John` and whose interview status is `ACCEPTED`.
* `search t/Internal` returns candidates whose tags contain `Internal`.

### Tag a candidate: `tag`

Appends the tag or tags to a candidate's list of tags.

You can list any number of tags greater than 0, and all of them will be added to the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list.

Format: `tag INDEX [t/TAG]…​`

At least one tag must be provided.

*Example 1* : `tag 24 t/smart`

This command adds the tag "smart" to the candidate with index 24.

*Example 2* : `tag 8 t/Exceptional work t/IMO gold t/Male`

This command adds the tags "Exceptional work", "IMO gold" and "Male" to the candidate with index 8.

If tag command is successfully executed, the app will display the candidate with the new tags.

### Change status of a candidate: `status`

Changes the interview status of a candidate.

Interview status must be one of the following: `PRESCREEN`, `IN_PROGRESS`, `WAITLIST`, `ACCEPTED`, `REJECTED`.
When a candidate is added, by default it has status `PRESCREEN`.
Format: `status INDEX INTERVIEWSTATUS`

*Example 1* : `status 24 IN_PROGRESS`

This command changes the status of the candidate with index 24 to `IN_PROGRESS`.

If status command is successfully executed, the app will display the candidate with the new status.


### Exiting the program : `exit`

Exits the program.
Expand Down Expand Up @@ -237,5 +272,7 @@ Action | Format, Examples
**Edit** | `edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG]…​`<br> e.g.,`edit 24 n/Johnny Doe e/johnnydoe@gmail.com c/Singapore`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**Search** | `search [n/NAME] [e/EMAIL] [c/COUNTRY] [m/COMMENT] [p/PHONE] [s/INTERVIEW_STATUS] [t/TAG]`
**Tag** | `tag INDEX [t/TAG]…`<br> e.g., `tag 8 t/Exceptional work t/IMO gold t/Male`
**Status** | `status INDEX INTERVIEWSTATUS`<br> e.g., `status 24 IN_PROGRESS`
**List** | `list`
**Help** | `help`

0 comments on commit b52d664

Please sign in to comment.