Sharing iP code quality feedback [for @salty-flower] - Round 2

[nus-se-script]

@salty-flower 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

Example from src/main/java/Tach.java lines 25-28:

    /**
     * The main method to launch the program.
     * @param args Command line arguments.
     */

Example from src/main/java/services/Dispatcher.java lines 62-65:

    /**
     * The lambda expression from driver class to indicate exit of the entire program.
     * @param toExit The lambda to trigger program exit.
     */

Example from src/main/java/services/SpeakerRegistry.java lines 13-16:

    /**
     * Add a new speaker.
     * @param s Speaker to add.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message (Subject Only)

possible problems in commit 54659d4:

:children_crossing:Improve GUI

• Not in imperative mood (?)

possible problems in commit a6ca6c8:

:children_crossing:Fix ellipsis

• Not in imperative mood (?)

possible problems in commit a8fb7ea:

:children_crossing:Improve GUI

• Not in imperative mood (?)

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 👍

❗ 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 [email protected] if you want to follow up on this post.