mfjkri / ip Goto Github PK

@mfjkri 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 67-70:

    /**
     * You should have your own function to generate a response to user input. Replace this stub with your completed
     * method.
     */

Example from src/main/java/duke/Launcher.java lines 9-13:

    /**
     * The main entry point for the application.
     *
     * @param args The command-line arguments passed to the application.
     */

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

Add friendlier syntax and remove parameter order

Currently parameters must be specified in a specific order and
the root command can be long to type.

This makes it troublesome of the users to remember the order of parameters
as well as the full word of the command.

We now allow for parameters to be specified in any order while still
having proper input validation for existence and typing of it.
Commands are also given shortened forms as shortcut (e.g. delete: rm).

This way we allow for greater flexibility and make the CLI more intuitive to
the user.

• body not wrapped at 72 characters: e.g., This makes it troublesome of the users to remember the order of parameters

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.

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

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 Message

possible problems in commit b32de3a:

Add friendlier syntax and remove parameter order

Currently parameters must be specified in a specific order and
the root command can be long to type.

This makes it troublesome of the users to remember the order of parameters
as well as the full word of the command.

We now allow for parameters to be specified in any order while still
having proper input validation for existence and typing of it.
Commands are also given shortened forms as shortcut (e.g. delete: rm).

This way we allow for greater flexibility and make the CLI more intuitive to
the user.

• body not wrapped at 72 characters: e.g., This makes it troublesome of the users to remember the order of parameters

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 [email protected] if you want to follow up on this post.