Sharing iP code quality feedback [for @brandon-nam] #1
Description
@brandon-nam 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
No easy-to-detect issues 👍
Aspect: Recent Git Commit Message
possible problems in commit de49a5e:
Edit JAR Configuration in build.gradle
JAR file lets the user play with the chatbot.
Let's edit JAR configuration in build.gradle file so it creates JAR with JavaFX dependencies.
- body not wrapped at 72 characters: e.g.,
Let's edit JAR configuration in build.gradle file so it creates JAR with JavaFX dependencies.
possible problems in commit 64ad747:
Add greeting message and HelpCommand class
Users may need to learn how to use the chatbot.
Add greeting message with the help of HelpCommand for better user experience.
- body not wrapped at 72 characters: e.g.,
Add greeting message with the help of HelpCommand for better user experience.
possible problems in commit 8ee7ab6:
Fix checkstyle violations
Checkstyle is a useful gradle plugin to check any style convention violations.
Run checkstyle and fix any existing convention violation in the code.
- body not wrapped at 72 characters: e.g.,
Checkstyle is a useful gradle plugin to check any style convention violations.
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.