Skip to content

Sharing iP code quality feedback [for @veonlok] #1

@soc-se-bot

Description

@soc-se-bot

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

Example from src/main/java/yappy/Task/Event.java lines 15-15:

[TAB]/**

Example from src/main/java/yappy/Task/Event.java lines 16-16:

[TAB] * Creates a new Event task with the specified name and time range.

Example from src/main/java/yappy/Task/Event.java lines 17-17:

[TAB] *

Suggestion: As specified by the coding standard, use spaces instead of tabs.

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

Example from src/main/java/yappy/Ui/Ui.java lines 1-1:

package yappy.Ui;

Example from src/main/java/yappy/Ui/DialogBox.java lines 1-1:

package yappy.Ui;

Example from src/main/java/yappy/Ui/Main.java lines 1-1:

package yappy.Ui;

Suggestion: Follow the package naming convention specified by the coding standard.

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 Messages

No easy-to-detect issues 👍

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 cs2103@nus.edu.sg if you want to follow up on this post.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions