Sharing iP code quality feedback [for @jonushzw] #7
Description
@jonushzw 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
Example from src/main/java/wolfie/command/FindCommand.java lines 44-44:
//System.out.println(matchingTasks);Suggestion: Remove dead code from the codebase.
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 94f3f00:
Add error handling for more cases
Environment issues: Add try catch blocks to check for files that do not exist
Deadline and Task subclasses: Add time check
- body not wrapped at 72 characters: e.g.,
Environment issues: Add try catch blocks to check for files that do not exist
possible problems in commit a08d057:
Add detection for duplicates
Changed equals method to check for matching names.
Each task type has a boolean check to check for a repeat of the same task.
If the task already exists, a message saying it already exists is printed and the task will not be added.
- body not wrapped at 72 characters: e.g.,
Each task type has a boolean check to check for a repeat of the same task.
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 cs2103@comp.nus.edu.sg if you want to follow up on this post.