Sharing iP code quality feedback [for @basil-boh]

[soc-se-bot]

@basil-boh 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

Example from src/main/java/steve.tasks/Task.java lines 21-21:

    private boolean done;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

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/steve/ui/Steve.java lines 35-40:

    /**
     * The main method that runs the application.
     * Loads tasks from the file, initializes the TaskManager and UserInterface, and starts the application.
     *
     * @param args command-line arguments (not used)
     */

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 Messages

possible problems in commit d20943e:

- Configure javafx files
- Create first node, scene & stage

• No blank line between subject and body

possible problems in commit de7676f:

- Add javadoc comments for all classes and methods
- amend code to adhere to checkstyle

• No blank line between subject and body

possible problems in commit 30f8932:

- Implemented Find
- Added FindCommand
- Amended CommandCreate and TaskManager

• 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 cs2103@comp.nus.edu.sg if you want to follow up on this post.