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

[soc-se-bot-blue]

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

Example from src/main/java/kevin/Parser.java lines 107-107:

                //assert splitInput.length == 2 : "ToDo should have a description";

Example from src/main/java/kevin/Parser.java lines 110-110:

                //assert splitInput.length == 2 : "Deadline should have a description";

Example from src/main/java/kevin/Parser.java lines 112-112:

                //assert deadlineParts.length == 2 : "Deadline should have a time";

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/kevin/Kevin.java lines 24-28:

    /**
     * The main entry point for the Duke application.
     *
     * @param args
     */

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 62ad85d:

Added the product screenshot

• Not in imperative mood (?)

possible problems in commit d3f2b1e:

Added the welcome message

• Not in imperative mood (?)

possible problems in commit 4af9443:

Merge branch 'branch-A-Personality'
Merge the personality branch

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

---

❗ 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.