Sharing iP code quality feedback [for @butteredyakiimo]

[nus-se-bot]

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message

possible problems in commit 5b2654a:

Modify code to adhere to code quality standards.

Some methods are extremely long, and have more than one
level of abstraction. Magic numbers are used to describe
the task status.

Let's make more methods to adhere to SLAP and avoid nested code,
and also create a new Enum to make code easier to understand.

• Subject line should not end with a period

possible problems in commit ce2258a:

Add assertions to some classes.

Assertions help to detect possible bugs, as they
verify certain assumptions that the code makes.
Gradle run is also configured to enable assertions.

• Subject line should not end with a period

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.