Sharing iP code quality feedback [for @papataco14]

[soc-se-script]

@papataco14 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/chad/chatengine/ChatEngine.java lines 226-229:

    /**
     * You should have your own function to generate a response to user input.
     * Replace this stub with your completed method.
     */

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

Update tests and build.gradle

This commit includes two main changes:

1. Update unit tests for the `handleEvent` method in the ChatEngine class.
   - Tests now check for the expected output string when a valid event is added.
   - This ensures that the handler method is working as expected and producing the correct output.

2. Modify the `build.gradle` file to set the new entry point for the application.
   - The `mainClass` attribute in the `application` block has been updated to point to the new GUI launcher class.
   - This change is necessary due to the implementation of the new GUI.

These changes collectively improve the robustness of the application and prepare it for the new GUI implementation.

• body not wrapped at 72 characters: e.g., 1. Update unit tests for the handleEvent method in the ChatEngine class.

possible problems in commit 8f15b48:

fixed formatting

• Not in imperative mood (?)

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.