Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix check style #299

Merged
merged 5 commits into from
Nov 16, 2023
Merged

fix check style #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3a9454e
fix checkstyle errors
waseemingly Nov 16, 2023
8afd349
fix check style
waseemingly Nov 16, 2023
850f366
fix checkstyle
waseemingly Nov 16, 2023
4897955
fix checkstyle errors
waseemingly Nov 16, 2023
b5c0a7b
fix check style
waseemingly Nov 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,10 @@ from always needing to call the list command.

## ***Quick start***

1. Ensure you have Java `11` or above installed in your Computer.
1. Ensure you have Java `11` or above installed in your Computer.


2. Download the latest `CodeContact.jar`.
2. Download the latest `CodeContact.jar`.


3. Copy the file to the folder you want to use as the _home folder_ for your CodeContact.
Expand Down Expand Up @@ -237,7 +237,7 @@ This is a tutorial for **first-time** CodeContact users.
1. Launch CodeContact. You may refer to the instructions [here](#quick-start).
* On launch, CodeContact will not contain any developer or client records.
<br/>


2. You will be asked to **enter a password** to unlock CodeContact.
* Enter the command `unlock pw/Password123!` in the command box.
Expand Down Expand Up @@ -377,7 +377,7 @@ Locked all data

**Format:** `unlock pw/CURRENT_PASSWORD`

**Constraints:**
**Constraints:**
1. Only unlocks if password exactly matches the current password (which is the last set password).
* Note: The default password is `Password123!`. It is highly recommended to change to a different password with the [`change-password` command](#change-password--change-password).

Expand All @@ -397,10 +397,10 @@ Unlocked all data

**Format:** `change-password pw/CURRENT_PASSWORD npw/NEW_PASSWORD`

**Constraints:**
**Constraints:**
1. `CURRENT_PASSWORD` entered must exactly match the current password.
* Note: The default password is `Password123!`.

2. `NEW_PASSWORD` must be at least 8 characters long and contain at least one digit, one lowercase letter,
one uppercase letter, and one special character.

Expand Down Expand Up @@ -432,13 +432,13 @@ Password changed successfully.

**Constraints:**
1. `NAME` cannot be the same as another existing developer's name in the address book. Checks are case-insensitive.
2. `PROJECT_NAME` should be the exact name of an existing project if specified.
2. `PROJECT_NAME` should be the exact name of an existing project if specified.
If project to be assigned does not exist, consider [adding the project](#add-project--add-project) first!


**Optional Fields:**
**Optional Fields:**
1. `PROJECT_NAME` - if prefix pr/ is missing in the command, the added developer will not be assigned to any projects.

2. `DATE_JOINED` - if prefix d/ is missing in the command, the added developer's date joined field will automatically reflect today's date.


Expand All @@ -447,8 +447,8 @@ If project to be assigned does not exist, consider [adding the project](#add-pro
may not be reflected as clearly in the coloured stars.


**Example of usage:**
`add-developer n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 r/Developer
**Example of usage:**
`add-developer n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 r/Developer
pr/AndroidApp pr/CustomWebsite s/4500 d/11-11-2023 g/johng rt/3`


Expand Down Expand Up @@ -484,8 +484,8 @@ Entered details of a developer incorrectly? You can always undo the action with

**Constraints:**
1. `NAME` cannot be the same as another existing client's name in the address book. Checks are case-insensitive.
2. `PROJECT_NAME` should be the exact name of an existing project if specified.

2. `PROJECT_NAME` should be the exact name of an existing project if specified.
If project to be assigned does not exist, consider [adding the project](#add-project--add-project) first!

**Optional Fields:**
Expand Down Expand Up @@ -532,7 +532,7 @@ Entered details of a client incorrectly? You can always undo the action with the
**Optional Fields:**
1. `DEADLINE` - if prefix dl/ is missing in the command, the added project will not have any deadlines assigned to it.

**Example of usage:**
**Example of usage:**
`add-project n/JuiceApp dr/App to allow for different juices to be ordered dl/19-12-2023,Design backend,HIGH,0 dl/25-12-2023,Design frontend,MEDIUM,0`


Expand Down Expand Up @@ -606,7 +606,7 @@ Deleted a wrong developer? You can always undo the action with the [`undo`](#und
**Constraints:**
1. `INDEX` cannot be greater than the number of clients in the list.

**Example of usage:** `delete-client 3`
**Example of usage:** `delete-client 3`

When command succeeds, CLI shows:
```
Expand Down Expand Up @@ -684,7 +684,7 @@ Deleted a wrong project? You can always undo the action with the [`undo`](#undo)
**Constraints:**
1. `NAME` cannot be the same as another existing developer's name in the address book. Checks are case-insensitive.
You can, however, edit the casing of an existing developer's `NAME`.
2. `PROJECT_NAME` should be the exact name of an existing project.
2. `PROJECT_NAME` should be the exact name of an existing project.
3. At least one of the optional fields must be provided.

**Additional Notes:**
Expand Down Expand Up @@ -814,17 +814,17 @@ You can always undo the action with the [`undo`](#undo) command!

**Column Header Format (for CSV file):** `Name`, `Contact Number`, `Email`, `Address`, `Date Joined`, `Role`, `Salary`, `GithubId`, `Rating`, `Projects`

**Constraints:**
**Constraints:**
1. The CSV file has to be in the same folder as the JAR file for the command to function correctly.

2. The CSV file has to strictly follow the column header names and order (given in the example).
2. The CSV file has to strictly follow the column header names and order (given in the example).
The entire command will abort if any of column headers do not follow the given format.

3. `NAME` and `PROJECT_NAME` fields for developers to be added via the import feature have the same constraints as the [`add-developer` command](#add-developer--add-developer) constraints.
The entire command will abort if any of the rows have invalid values that do not comply with given constraints.
3. `NAME` and `PROJECT_NAME` fields for developers to be added via the import feature have the same constraints as the [`add-developer` command](#add-developer--add-developer) constraints.
The entire command will abort if any of the rows have invalid values that do not comply with given constraints.

**Optional Fields:**
While `PROJECT` and `DATE JOINED` column headers are compulsory, they are optional fields, where values (corresponding to the developer to be added) under these columns can be empty.
**Optional Fields:**
While `PROJECT` and `DATE JOINED` column headers are compulsory, they are optional fields, where values (corresponding to the developer to be added) under these columns can be empty.

If values are empty, corresponding developers will be added with `DATE JOINED` automatically set to today and/or with no projects assigned to them, like the [`add-developer` command](#add-developer--add-developer).

Expand Down Expand Up @@ -870,16 +870,16 @@ Reads a CSV file and populates the addressbook with the clients provided.
**Column Header Format (for CSV file):** `Name`, `Contact Number`, `Email`, `Address`, `Role`, `Organisation`, `Document`, `Projects`


**Constraints:**
**Constraints:**
1. The CSV file has to be in the same folder as the JAR file for the command to function correctly.
2. The CSV file has to strictly follow the column header names and order (given in the example).

2. The CSV file has to strictly follow the column header names and order (given in the example).
The entire command will abort if any of column headers do not follow the given format.

3. `NAME` and `PROJECT_NAME` fields for clients to be added via the import feature have the same constraints as the [`add-client` command](#add-client--add-client) constraints. The entire command will abort if any of the rows have invalid values that do not comply with given constraints.
3. `NAME` and `PROJECT_NAME` fields for clients to be added via the import feature have the same constraints as the [`add-client` command](#add-client--add-client) constraints. The entire command will abort if any of the rows have invalid values that do not comply with given constraints.

**Optional Fields:**
While the `PROJECT` column header is compulsory, it is an optional fields, where values (corresponding to the client to be added) under this column can be empty.
**Optional Fields:**
While the `PROJECT` column header is compulsory, it is an optional fields, where values (corresponding to the client to be added) under this column can be empty.

If values under the `PROJECT` column are empty, corresponding clients will be added with no projects assigned to them, like the [`add-client` command](#add-client--add-client).

Expand Down Expand Up @@ -929,7 +929,7 @@ for each client successfully added.
> Finds the details of an existing developer in the address book.

**Format:**
`find-developer [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED]
`find-developer [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DATE_JOINED]
[r/ROLE] [s/SALARY] [pr/PROJECT_NAME] [g/GITHUB_ID] [rt/RATING]`

**Additional notes:**
Expand Down Expand Up @@ -970,7 +970,7 @@ This is the one developer with matching information.
* You can combine multiple attributes for a more specific search.
* The search is case-insensitive, so you can use any case for the search criteria.

**Example of usage:**
**Example of usage:**
`find-client o/Google r/Senior developer`

* Prints clients from Google with the Senior developer role.
Expand Down
2 changes: 1 addition & 1 deletion docs/team/mingyu-wan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ adding clarity to the role assignment process. A pre-added list of roles for cli
<br>

* **Enhancements to existing features**:
* Modified list feature to work with our new tab and fields (Pull requests [\#113](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/113))
* Modified list feature to work with our new tab and fields (Pull requests [\#113](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/113))
* Fixed parts of the test cases to pass again (Pull requests [\#225](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/225))
* Increased code coverage from `32.28%` to `38%` and from `48.9%` to `54.39%`.(Pull requests [\#250](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/250)
[\#241](https://github.com/AY2324S1-CS2103T-T09-2/tp/pull/241))
Expand Down
1 change: 0 additions & 1 deletion pword.txt
View file
Open in desktop

This file was deleted.