Skip to content

Commit

Permalink
Merge pull request #246 from 0liverkong/Update-UG
Browse files Browse the repository at this point in the history 
Update parameter information
  • Loading branch information
@chiralcentre
chiralcentre authored Apr 14, 2024
2 parents 85b520e + 540481b commit 2827d9c
Showing 1 changed file with 13 additions and 19 deletions.
32 changes: 13 additions & 19 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,24 +57,18 @@ HireHub is a **desktop app for managing candidates, optimized for use via a Comm

* These are the constraints for each of the parameters (this applies to all commands):

* **NAME**: cannot be blank, and only alphanumeric characters and spaces are allowed. In particular, special characters such as `/` and `-` and non-English characters (e.g. Chinese characters) are not allowed. This would be part of the planned improvements.
* **PHONE**: cannot be blank and must adhere to the following constraints:
* International phone numbers should contain a country code in front (+ followed by 1 to 3 digits), then a space, followed by a combination of digits, spaces, parentheses or hyphens with at least 3 digits.
* If country code is omitted, it must be a valid Singapore phone number. It must start with 3, 6, 8 or 9 and must be in the following formats: `XXXXYYYY`, `XXXX-YYYY` or `XXXX YYYY`.
* Other than the above constraints, there is no other validation to check if a country code is valid. Furthermore, given a country code, there is no phone validation specific to the country code. This would be part of the planned improvements.
* **EMAIL**: must be of the format local-part@domain and adhere to the following constraints:
* The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters.
* This is followed by a '@' and then a domain name. The domain name is made up of domain labels separated by periods. The domain name must:
- end with a domain label at least 2 characters long
- have each domain label start and end with alphanumeric characters
- have each domain label consist of alphanumeric characters, separated only by hyphens, if any.
* **COUNTRY**: must be a valid ISO-3166-1 alpha-2 code which can be found from https://www.iso.org/obp/ui/#search/code/. It is case-sensitive and must be in ALL CAPITALS. Alternatively, you can refer to the [appendix](#appendix-country-codes) for the exact ISO code to use for each country. Note that the value for country field shown on the UI is the English display name equivalent of the ISO code for user convenience, and what is actually stored in the backend is the ISO code.
* **TAG**: cannot be blank (except in edit command), and only alphanumeric characters are allowed.
* **COMMENT**: can be blank and does not have any constraints.
* **TITLE**: cannot be blank and has a character limit of 100.
* **DESCRIPTION**: can be blank and does not have any constraints.
* **VACANCY**: must be a positive integer.
* **STATUS**: must be one of the following 5 statuses (not case-sensitive): PRESCREEN, IN_PROGRESS, WAITLIST, OFFERED, REJECTED
| Parameter | Prefix | Format |
|-----------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **NAME** | n/ | Cannot be blank, and only alphanumeric characters and spaces are allowed. In particular, special characters such as `/` and `-` and non-English characters (e.g. Chinese characters) are not allowed. This would be part of the planned improvements. |
| **PHONE** | p/ | Cannot be blank and must adhere to the following constraints: <br><br> 1. International phone numbers should contain a country code in front (+ followed by 1 to 3 digits), then a space, followed by a combination of digits, spaces, parentheses or hyphens with at least 3 digits. <br><br> 2. If country code is omitted, it must be a valid Singapore phone number. It must start with 3, 6, 8 or 9 and must be in the following formats: `XXXXYYYY`, `XXXX-YYYY` or `XXXX YYYY`. <br><br>3. Other than the above constraints, there is no other validation to check if a country code is valid. Furthermore, given a country code, there is no phone validation specific to the country code. This would be part of the planned improvements. |
| **EMAIL** | e/ | Must be of the format local-part@domain and adhere to the following constraints: <br><br> 1. The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters. <br><br> 2. This is followed by a '@' and then a domain name. The domain name is made up of domain labels separated by periods. The domain name must: <br><br> 2a. end with a domain label at least 2 characters long <br> 2b. have each domain label start and end with alphanumeric characters <br> 2c. have each domain label consist of alphanumeric characters, separated only by hyphens, if any. |
| **COUNTRY** | c/ | Must be a valid ISO-3166-1 alpha-2 code which can be found from https://www.iso.org/obp/ui/#search/code/. It is case-sensitive and must be in ALL CAPITALS. Alternatively, you can refer to the [appendix](#appendix-country-codes) for the exact ISO code to use for each country. Note that the value for country field shown on the UI is the English display name equivalent of the ISO code for user convenience, and what is actually stored in the backend is the ISO code. |
| **TAG** | t/ | Cannot be blank (except in edit command), and only alphanumeric characters are allowed. |
| **COMMENT** | None | Can be blank and does not have any constraints. |
| **TITLE** | ti/ | Cannot be blank and has a character limit of 100. |
| **DESCRIPTION** | d/ | Can be blank and does not have any constraints. |
| **VACANCY** | v/ | Must be a positive integer. |
| **STATUS** | s/ | Must be one of the following 5 statuses (not case-sensitive): PRESCREEN, IN_PROGRESS, WAITLIST, OFFERED, REJECTED | | | |

* These are the primary key (i.e. no 2 items can have the same parameter) of candidates, jobs and applications respectively:
* **Candidates**: EMAIL
Expand Down Expand Up @@ -141,7 +135,7 @@ The following is an example of how the `add_job` command can be run in the GUI.

![AddJobCommand](images/add-job/AddJobCommand.png)

After the application has been successfully added, a success message will be shown in the output box. You can also see your new job in the job list display as seen below.
After the application has been successfully added, a success message will be shown in the output box. You can also see your new job in the job list display as seen below

![AddJobOutput](images/add-job/AddJobOutput.png)

Expand Down

0 comments on commit 2827d9c

Please sign in to comment.