Sharing iP code quality feedback [for @xa0412]

[nus-se-script]

@xa0412 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

Example from src/main/java/task/TaskManager.java lines 325-325:

        boolean found = false;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Messages

possible problems in commit 370192c:

Update TaskManager and XanChatBot class message.

• Subject line should not end with a period

possible problems in commit 73f280d:

Update TaskManager.java on codeQuality
-Update constant variables using SCREAMING_SNAKE_CASE

• No blank line between subject and body

possible problems in commit 3eee83e:

Refactor: Improve code quality in TaskManager.java and XanChatBot.java
This commit refactors TaskManager.java and XanChatBot to improve code quality, readability, and maintainability.

Changes include:
-Refactored logic in methods like enum TaskType, addTask(), showTask() and searchTask() to improve clarity and reduce duplication.
-Enhanced method descriptions and added inline comments for better understanding of the code.
-Improved consistency and readability of conditionals

These changes aim to streamline task management, enhance code readability, and ensure that tasks are handled efficiently with minimal redundancy.

• No blank line between subject and body
• body not wrapped at 72 characters: e.g., This commit refactors TaskManager.java and XanChatBot to improve code quality, readability, and maintainability.

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 👍

---

ℹ️ 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 cs2103@comp.nus.edu.sg if you want to follow up on this post.