Sharing iP code quality feedback [for @ryanczx]

[soc-se-bot-red]

@ryanczx 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/commands/AddCommand.java lines 23-27:

    /**
     * Create AddCommand
     * @param type type of task
     * @param description description of task
     */

Example from src/main/java/commands/AddCommand.java lines 34-39:

    /**
     * Create AddCommand
     * @param type type of task
     * @param description description of task
     * @param date date of task
     */

Example from src/main/java/commands/DeleteCommand.java lines 15-18:

    /**
     * Add DeleteCommand
     * @param index index of task to be deleted
     */

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 (Subject Only)

possible problems in commit 653ab33:

Move the parsing of dateString into date into extracted methods for load method inside Storage.java

• Longer than 72 characters

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.