Sharing iP code quality feedback [for @volleyballkickedme]

[soc-se-bot]

@volleyballkickedme 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/FRIDAY/Deadline.java lines 1-1:

package FRIDAY;

Example from src/main/java/FRIDAY/Event.java lines 1-1:

package FRIDAY;

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

package FRIDAY;

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

Example from src/main/java/FRIDAY/Storage.java lines 58-62:

    /**
     * method to populate the program storage with data read from the hard drive
     *
     * @param data string to represent all the details of the task, including its type and other miscellaneous details
     */

Example from src/main/java/FRIDAY/TaskList.java lines 38-42:

    /**
     * Method returns a String representation of the list of tasks if there are any.
     * If no tasks are available, it returns a String to communicate that
     * @return String representation of the list of tasks
     */

Example from src/main/java/FRIDAY/Ui.java lines 39-42:

    /**
     * method displays the list of tasks in a specific format
     * @param searchResults array list of tasks
     */

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

No easy-to-detect issues 👍

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.