Sharing iP code quality feedback [for @arshinsikka] - Round 2 #2
Description
@arshinsikka 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
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 Messages
possible problems in commit 8cf6b34:
Update usage commands in README for better formatting
The table-based approach caused formatting issues on GitHub Pages.
Replaced it with a text-based format using headings and examples.
This ensures the commands are displayed clearly and consistently for users.
- body not wrapped at 72 characters: e.g.,
This ensures the commands are displayed clearly and consistently for users.
possible problems in commit 082dbd7:
Fix coding standard violations
Fix various Java coding standard issues across the project.
- Enforce proper naming conventions (camelCase, PascalCase, SCREAMING_SNAKE_CASE).
- Use K&R style brackets and add spaces around operators.
- Replace wildcard imports with explicit imports.
- Add missing Javadoc comments for public methods.
These changes improve code readability and maintainability.
- body not wrapped at 72 characters: e.g.,
- Enforce proper naming conventions (camelCase, PascalCase, SCREAMING_SNAKE_CASE).
possible problems in commit 30a0a06:
Improve SLAP compliance in command processing
Refactored getResponse() and run() methods to follow SLAP principles. Extracted helper methods to reduce deep nesting and improve readability.
- body not wrapped at 72 characters: e.g.,
Refactored getResponse() and run() methods to follow SLAP principles. Extracted helper methods to reduce deep nesting and improve readability.
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.