Sharing iP code quality feedback [for @m1oojv]

[soc-se-script]

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

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/Sam/commands/Command.java lines 18-20:

    /**
     * Flag that it is the end of the conversation.
     */

Example from src/main/java/Sam/services/Storage.java lines 23-27:

    /**
     * Ensure that the hard disk is present in the file directory.
     * Creates the file if not found
     * @return the new file created
     */

Example from src/main/java/Sam/services/TaskList.java lines 22-26:

    /**
     * Provide a copy of the entire taskList.
     *
     * @return the copy of the taskList
     */

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

Feat: Add C-Tagging
There is no way to tag tasks in the code

Tagging tasks is a useful organizational feature
in task management systems. Tags allow us to
categorize tasks based on different criteria,
such as priority, project, context, or location.

Let's add this new feature of tagging tasks in our task list
for a better user experience

• No blank line between subject and body

possible problems in commit df25f62:

Update A-Assertions
There is no assertions in the code

Assertions are used to define assumptions about the program state so that the runtime can verify them.
Assertions serve a valuable purpose by aiding programmers
in verifying the accuracy of our assumptions and
ensuring that no invariants are breached.

We should incorporate assertions into the code in areas
where it's crucial to validate these assumptions.

• No blank line between subject and body
• body not wrapped at 72 characters: e.g., Assertions are used to define assumptions about the program state so that the runtime can verify them.

possible problems in commit 9e63aef:

Add Level 10. GUI
Add a GUI to the chatbot. Use the JavaFX technology to implement the GUI.

• No blank line between subject and body
• body not wrapped at 72 characters: e.g., Add a GUI to the chatbot. Use the JavaFX technology to implement the GUI.

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.