Sharing iP code quality feedback [for @zacharylwy]

[nus-se-bot]

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 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: Header Comments

Example from src/main/java/duke/Parser.java lines 27-31:

    /**
     * Interpret what the user has entered as an input and categorises it into a Command.
     * @param input User's input
     * @return The correct command that is interpreted from the user input.
     */

Example from src/main/java/duke/Task.java lines 19-22:

    /**
     * Correctly assigns the task a string that indicates if it has been marked as done or not.
     * @return String that hows the correct icon.
     */

Example from src/main/java/duke/Task.java lines 31-34:

    /**
     * Return the status of whether the Task is done.
     * @return Boolean indicating if Task is done.
     */

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 fdbd2d7:

Updated build.gradle

• Not in imperative mood (?)

possible problems in commit 29d5d55:

Update

• Perhaps too short (?)

possible problems in commit 64cfbcc:

Fixed merge conflicts

• Not in imperative mood (?)

Suggestion: Follow the given conventions for Git commit messages

ℹ️ The bot account @cs2103-bot 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.