Sharing iP code quality feedback [for @jaylontan]

[soc-se-bot]

@jaylontan 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/teddy/TaskList.java lines 160-160:

        boolean found = false;

Example from src/main/java/teddy/Task.java lines 6-6:

    private boolean done;

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 63e53d8:

Merge branch 'branch-BCD-Extensions'

Prevent duplicate tasks from being added to TaskList

Previously, users could add duplicate tasks, leading to redundancy in the task
list. This commit implements a check using the equals() method to ensure that
each new task is unique before adding it to the list.

- Modified addTodo, addDeadline, and addEvent to check for duplicates before adding.
- Implemented contains() check leveraging the updated equals() method in Task.
- Updated error handling to provide clear feedback when a duplicate task is detected.

This change improves task list integrity and prevents redundant storage operations.

• body not wrapped at 72 characters: e.g., Previously, users could add duplicate tasks, leading to redundancy in the task

possible problems in commit 20dd866:

Merge branch 'master' into branch-A-CodeQuality
Merge master into branch-A-CodeQuality

• No blank line between subject and body

possible problems in commit a1e6063:

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

• 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 👍

---

ℹ️ 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.