Sharing iP code quality feedback [for @alyssaongyx]

[soc-se-bot-red]

@alyssaongyx 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

Example from src/main/java/ally/Ally.java lines 42-42:

    //    public void run() {

Example from src/main/java/ally/Ally.java lines 43-43:

    //        ui.start();

Example from src/main/java/ally/Ally.java lines 44-44:

    //        boolean isExit = false;

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/ally/Ui.java lines 36-38:

    /**
     * Function that provides the starting message and greeting.
     */

Example from src/main/java/ally/Ui.java lines 45-50:

    /**
     * Function that provides the bye message when the user
     * ends the chatbot.
     *
     * @return
     */

Example from src/main/java/ally/tasks/AllyList.java lines 16-19:

    /**
     * Function to add tasks from the input into the arraylist.
     * @param task
     */

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 cd9b5bf:

Removed the gradle file due to some errors

• Not in imperative mood (?)

possible problems in commit 74fca25:

Update quality of code.

Remove unnecessary large blocks of comments.

Large blocks of comments would make the code untidy.

• Subject line should not end with a period

possible problems in commit 3d31fe7:

Add assertions

Commands have run method which contains allylist, ui and storage attributes.

The attributes can be empty. However, commands like delete command could still occur.

Assertions causes exceptions when this issue arises.

• body not wrapped at 72 characters: e.g., Commands have run method which contains allylist, ui and storage attributes.

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 👍

---

ℹ️ 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.