Sharing iP code quality feedback [for @ChillinRage]

[nus-se-script]

@ChillinRage 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/someboty/Exceptions/InputException.java lines 1-1:

package someboty.Exceptions;

Example from src/main/java/someboty/Exceptions/TerminateException.java lines 1-1:

package someboty.Exceptions;

Example from src/main/java/someboty/Managers/commandManager.java lines 1-1:

package someboty.Managers;

Suggestion: Follow the package naming convention specified by the coding standard.

Aspect: Class Name Style

Example from src/main/java/someboty/someBOTy.java lines 15-15:

public class someBOTy extends Application {

Example from src/main/java/someboty/Managers/taskManager.java lines 15-15:

public class taskManager {

Suggestion: Follow the class naming convention specified by the coding standard.

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/someboty/Managers/dateManager.java lines 55-59:

    /**
     * Convert a date and time into a more reader-friendly format.
     * @param date A LocalDateTime object to format.
     * @return String representation of the date and time.
     */

Example from src/main/java/someboty/Managers/fileManager.java lines 39-42:

    /**
     * Read saved tasks from the csv file and converts it into a list.
     * @return A list of tasks.
     */

Example from src/main/java/someboty/Managers/taskManager.java lines 61-68:

    /**
     * Set the completion status of a task in the task list.
     * Status is set to true if the task is marked as completed, else set to false.
     * @param index The i-th position of the task in the list. (1-indexed)
     * @param status The completion status of the task to set.
     * @return The task in the i-th position on the list.
     * @throws InputException If index argument is out of task list's range.
     */

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

possible problems in commit 4e3745b:

Added Launcher

• Not in imperative mood (?)

possible problems in commit 4f18d38:

A-JavaDoc

Provided JavaDoc comments to most of the non-private (and some private) methods and classes.

• body not wrapped at 72 characters: e.g., Provided JavaDoc comments to most of the non-private (and some private) methods and classes.

possible problems in commit dcd91b8:

Level-9

Added "find" feature to allow user to find tasks that matches the given substring.

Changed return type of "addTask", "deleteTask" and "setTaskStatus" in "taskManager" to Task (previously String). The formatting of output string will now be handled in commandManager.

Fixed bug that causes the fileWriter to throw an error when trying to write to file.

• Perhaps too short (?)
• body not wrapped at 72 characters: e.g., Added "find" feature to allow user to find tasks that matches the given substring.

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.