Sharing iP code quality feedback [for @Zonnie-23]

[soc-se-script]

@Zonnie-23 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/test/java/DeadlineCommandTest.java lines 32-32:

        boolean result = true;

Example from src/main/java/nova/Nova.java lines 80-80:

            boolean toExit = currCommand instanceof ByeCommand;

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Messages

possible problems in commit dc50963:

Add separate save feature

Save command: allow user to save todo list at any time

User can only save when exiting program

User may accidentally enter no when exiting the programs. Therefore, to avoid such situations, allow

Let's handle another case where the user responds save to the chatbot. In this case, the current To-do List will be saved. When exiting the program, the program will only save before exit if the user responds "save" when prompted.

This is to minimise accidental loss of unsaved data, while not overaggressively saving/updating user's list.

• body not wrapped at 72 characters: e.g., User may accidentally enter no when exiting the programs. Therefore, to avoid such situations, allow

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.