Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sharing iP code quality feedback [for @Anonymxtrix] #29

Open
nus-se-bot opened this issue Sep 11, 2021 · 0 comments
Open

Sharing iP code quality feedback [for @Anonymxtrix] #29

nus-se-bot opened this issue Sep 11, 2021 · 0 comments

Comments

@nus-se-bot
Copy link

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/exception/UserException.java lines 11-14:

    /**
     * Create a duke.exception.UserException with the specified Message.
     * @param message The message to be displayed in the duke.Response.
     */

Example from src/main/java/duke/task/TaskCollection.java lines 64-68:

    /**
     * Parse a String of Tasks into a List.
     * @param string The input String of Tasks
     * @return The List of Tasks
     */

Example from src/main/java/duke/task/TaskCollection.java lines 101-104:

    /**
     * Get the number of Tasks in the duke.task.TaskCollection.
     * @return The size of the duke.task.TaskCollection.
     */

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 0203b0e:

Merge remote-tracking branch 'origin/add-gradle-support' into branch-A-Gradle

  • Longer than 72 characters

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant