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

[soc-se-bot]

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