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 @rizkidelta] #4

Open
nus-se-bot opened this issue Feb 17, 2024 · 0 comments
Open

Sharing iP code quality feedback [for @rizkidelta] #4

nus-se-bot opened this issue Feb 17, 2024 · 0 comments

Comments

@nus-se-bot
Copy link

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

Example from src/main/java/Exceptions/DukeException.java lines 1-1:

package Exceptions;

Example from src/main/java/Storage/Storage.java lines 1-1:

package Storage;

Example from src/main/java/Tasks/Deadline.java lines 1-1:

package Tasks;

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 Message

possible problems in commit b30d37f:


A-JUnit


  • Perhaps too short (?)

possible problems in commit f8ae85e:


Updated Data.txt

Data.txt blank as default


  • Not in imperative mood (?)

possible problems in commit bddf5ac:


A-MoreOOP
Refactor the code to extract out closely related code as classes.


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


ℹ️ 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.

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