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

[soc-se-bot]

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

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/echochat/Deadline.java lines 29-33:

    /**
     * Get the "by" String of the deadline.
     *
     * @return String stating when deadline is
     */

Example from src/main/java/echochat/Event.java lines 33-37:

    /**
     * Get starting date of event.
     *
     * @return String representing start of event
     */

Example from src/main/java/echochat/Event.java lines 42-46:

    /**
     * Get ending date of event.
     *
     * @return String representing end of event
     */

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 378ad58:

Add isDuplicate Method to ChatBot Class

The ChatBot class does not have a mechanism to prevent duplicate tasks from being added to the task list. This lack of functionality allows for multiple instances of identical tasks, which can clutter the task list and hinder user experience.

To improve task management and maintain a clean task list, we need to implement a check for duplicate tasks.

Add the isDuplicate method to the ChatBot class to identify and handle duplicate tasks before they are added. This method compares the new task with existing tasks based on their description and other properties.

Implement this method in the getResponse method to ensure that duplicate tasks are not added. If a task is detected as a duplicate, the user receives a notification to inform them of the duplicate entry.

This change enhances task management by preventing duplicate entries, which improves data integrity and overall user experience. By checking for duplicates before adding new tasks, the task list remains organized and user interactions become more efficient.

• body not wrapped at 72 characters: e.g., The ChatBot class does not have a mechanism to prevent duplicate tasks from being added to the task list. This lack of functionality allows for multiple instances of identical tasks, which can clutter the task list and hinder user experience.

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