Skip to content

Sharing iP code quality feedback [for @JasonRay168] - Round 2 #5

Description

@soc-se-bot-blue

@JasonRay168 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 97dd1d4:


Add an undo feature to undo most recent change

There might be some cases where users will accidentally delete or change the content of the list.

In such cases, an undo feature will be really helpful in helping users retrieve lost or changed information.

The undo feature can only allow users to undo the most recent change and cannot be used to undo more than one change.

Furthermore, the undo feature will only detect mark, unmark, delete, and the three add task commands as commands that change the content of the list. After all, the other features such as list and find does not change the contents of the task list.

Finally, upon exiting and restarting the chatbot, the undo will not work. It will only work when a change is made in the current session.


  • body not wrapped at 72 characters: e.g., There might be some cases where users will accidentally delete or change the content of the list.

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.

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