Sharing iP code quality feedback [for @ashmitahaldar] - Round 3

[nus-se-bot]

@ashmitahaldar We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

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/main/java/mayobot/util/SearchMatcher.java lines 67-67:

            boolean found = false;

Example from src/main/java/mayobot/commands/FindCommand.java lines 33-33:

    private final boolean fuzzySearch;

Example from src/main/java/mayobot/commands/FindCommand.java lines 34-34:

    private final boolean strictSearch;

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

Add User Guide and screenshot

Upon release, there is no guide for users to follow to learn how to use MayoBot.

Creating a user guide would be very beneficial for the user.

Let's add a user guide to the project.

• body not wrapped at 72 characters: e.g., Upon release, there is no guide for users to follow to learn how to use MayoBot.

possible problems in commit e717811:

A-AiAssisted: Add AI.md & tweaks to main.css

As part of the A-AiAssisted tag, the application lacks a AI.md Markdown file that outlines the use of AI in this project to speed up development.

Let's add the Ai.md file to keep a record of AI use in this chatbot. Additonally, let's make some minor tweaks to main.css file.

• body not wrapped at 72 characters: e.g., As part of the A-AiAssisted tag, the application lacks a AI.md Markdown file that outlines the use of AI in this project to speed up development.

possible problems in commit 2848114:

A-Moretesing: Add more JUnit tests

The JUnit tests in the application do not exhaustively cover all commands.

Having better and more JUnit tests covering more cases is better for ensuring the robustness of the chatbot.

Let's add more JUnit automated tests to cover more cases that can be tested automatically, by covering the Command classes and
its methods.

• body not wrapped at 72 characters: e.g., The JUnit tests in the application do not exhaustively cover all commands.

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 👍

---

❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality 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.