Sharing iP code quality feedback [for @conradsoon] - Round 2 #5
Description
@conradsoon 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/deterministicparrot/DeterministicParrot.java lines 19-19:
private boolean endParrot = false;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
Example from src/main/java/deterministicparrot/DeterministicParrot.java lines 325-325:
//this.ui.printDash();Example from src/main/java/deterministicparrot/DeterministicParrot.java lines 331-331:
//this.ui.printDash();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
Example from src/main/java/deterministicparrot/DeterministicParrot.java lines 51-55:
/**
* Main method to start the Deterministic Parrot application.
*
* @param args Command line arguments (not used).
*/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 1d94be2:
Implement "upcoming" command, which allows you to list all deadlines before a certain time
- Longer than 72 characters
possible problems in commit bb329b9:
Introduce assertions for robustness
Throughout the codebase, certain conditions assumed to be true can cause
unexpected behaviors if not met.
Incorporating assertions helps us enforce these conditions and brings
issues to the forefront during the development phase, preventing potential
runtime anomalies.
Let's,
* Add assertions in critical areas where assumptions are made
* Document the conditions we are asserting for clarity
Utilizing assertions will help in ensuring the software's robustness
and increase overall code quality.
- body not wrapped at 72 characters: e.g.,
issues to the forefront during the development phase, preventing potential
possible problems in commit 2a9858f:
Modify build.gradle and add image resources
The current project's build configuration lacks some necessary dependencies and resources.
To enhance the application's functionality and improve its UI, it's essential to incorporate new dependencies and assets.
Let's update the build.gradle file to include these dependencies and also introduce new image resources to the asset folder.
Adding these will improve app performance and provide a better user experience. The image resources include icons and background images essential for the app's UI/UX.
- body not wrapped at 72 characters: e.g.,
The current project's build configuration lacks some necessary dependencies and resources.
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.