Sharing iP code quality feedback [for @Arixeyeion]

[nus-se-bot]

@Arixeyeion 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 c80a8aa:

Add rest of the CodeQuality changes.

There were some magic numbers in the code so this commits rectify that problem.

Doing away with magic numbers makes it easier to debug in future and provides clarity in code.

• Subject line should not end with a period
• body not wrapped at 72 characters: e.g., There were some magic numbers in the code so this commits rectify that problem.

possible problems in commit 5f843c9:

Late commit for assertions.

Assertions were implemented as a branch but not committed to before working on the CodingQuality branch.

Let's commit this version with some CodingQuality implementation first as practice for pull requests.
This way, I still get to see the effects of some merging conflicts and parallel pull requests.

• Subject line should not end with a period
• body not wrapped at 72 characters: e.g., Assertions were implemented as a branch but not committed to before working on the CodingQuality branch.

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.