Sharing iP code quality feedback [for @hjuntan]

[soc-se-script]

@hjuntan 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/toothless/Toothless.java lines 14-16:

    /**
     * Construct a chatbot with a file storage at a predetermined file path.
     */

Example from src/main/java/toothless/Toothless.java lines 44-46:

    /**
     * Start the application and query the user to input commands.
     */

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 5f4d102:

Improve code quality

Rename remaining "duke" keywords present in the project to toothless to standardise the chatbot's name.

Refactor parsing of update and task commands in parseCommand to their respective methods to improve code readability.

Improve coding standard by adding appropreiate whitespaces.

• body not wrapped at 72 characters: e.g., Rename remaining "duke" keywords present in the project to toothless to standardise the chatbot's name.

possible problems in commit cba34a1:

Add assertions into essential parts of the code

Assert the index received when retriving or removing a task from the TaskList, should not be a negative number.
Assert the stored items are in the correct format.
Assert the parser understands the correct instructions only.

• body not wrapped at 72 characters: e.g., Assert the index received when retriving or removing a task from the TaskList, should not be a negative number.

possible problems in commit d765082:

Implement gui functionality fully.

• Subject line should not end with a period

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.