tim-siu / ip

ip project for the SWE course CS2103

User Guide for Kevin, formerly Duke

Features

Task Management

• Types of Tasks: You can manage tasks of various types including ToDo, Deadline, or Event.
• Operations: Create, modify, delete, and list tasks with ease.

Usage

Task Handling

todo - Add a ToDo task

Example:

todo Buy milk

Expected outcome: The ToDo task is added.

deadline - Add a Deadline task

Example:

deadline Submit ip final version /by 2023-09-22

Expected outcome: The Deadline task is added.

event - Add an Event task

Example:

event Recess Week /from 2023-09-22 /to 2023-09-29

Expected outcome: The Event task is added.

list - Display all tasks

Example:

list

Expected outcome: A list of all your tasks will be displayed, sorted by the order in which they were added.

mark - Mark a task as done

Example:

mark 2

Expected outcome: Task number 2 is marked as done.

unmark - Unmark a task as done

Example:

unmark 2

Expected outcome: Task number 2 is unmarked.

delete - Delete a task

Example:

delete 1

Expected outcome: Task number 1 is deleted.

find - Find tasks by keywords

Example:

find groceries

Expected outcome: Displays tasks containing the keyword "groceries".

sort - Sort tasks

Example:

sort

Expected outcome: Tasks are sorted based on their type (Event tasks by start time, Deadline tasks by deadline, ToDo tasks at the end).

clear - Clear all tasks

Example:

clear

Expected outcome: All tasks are cleared.

Miscellaneous

bye - Exit the program

Example:

bye

Expected outcome: Shows a goodbye message.

ip's Issues

Sharing iP code quality feedback [for @Tim-Siu]

@Tim-Siu We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

No easy-to-detect issues 👍

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/duke/Duke.java lines 25-31:

    /**
     * The main entry point for the Duke application.
     * Initializes the user interface, loads stored tasks from storage,
     * and then continuously waits for user input until the exit command is received.
     *
     * @param args Command-line arguments (unused).
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message

possible problems in commit ab7c730:

Merge branch 'branch-B-Sort'
Merge the extension branch B-Sort

• No blank line between subject and body

possible problems in commit f0e4010:

Merge branch 'branch-A-CodeQuality'
Merge the feature branch to master

• No blank line between subject and body

possible problems in commit 840fce5:

Merge branch 'master' into branch-A-CodeQuality
Merge master to the feature branch

• No blank line between subject and body

Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).

Aspect: Binary files in repo

No easy-to-detect issues 👍

---

ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.

Sharing iP code quality feedback [for @Tim-Siu] - Round 2

@Tim-Siu We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.

Aspect: Tab Usage

No easy-to-detect issues 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

Example from src/main/java/kevin/Parser.java lines 107-107:

                //assert splitInput.length == 2 : "ToDo should have a description";

Example from src/main/java/kevin/Parser.java lines 110-110:

                //assert splitInput.length == 2 : "Deadline should have a description";

Example from src/main/java/kevin/Parser.java lines 112-112:

                //assert deadlineParts.length == 2 : "Deadline should have a time";

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/kevin/Kevin.java lines 24-28:

    /**
     * The main entry point for the Duke application.
     *
     * @param args
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message

possible problems in commit 62ad85d:

Added the product screenshot

• Not in imperative mood (?)

possible problems in commit d3f2b1e:

Added the welcome message

• Not in imperative mood (?)

possible problems in commit 4af9443:

Merge branch 'branch-A-Personality'
Merge the personality branch

• No blank line between subject and body

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

Aspect: Binary files in repo

No easy-to-detect issues 👍

---

❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality issues.

ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.