Sharing iP code quality feedback [for @ruiming97] #2
Description
@ruiming97 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 afe66a5:
Refactor TaskList class to add assertions and improve task handling.
Let's,
* add assertions to the TaskList constructor to ensure the task list is not null.
* add assertions in the `addTask` method to validate that the task being added is not null.
* update the `getTask` method with assertions to check the retrieved task is not null.
* refactore `markTask` and `unmarkTask` methods to improve readability:
- add assertions to validate tasks are correctly marked as done or not done.
- refactor loops to store the retrieved task in a variable before processing.
- Simplify task marking logic by removing redundant code.
* sort task indices in descending order during deletion to avoid index errors when removing multiple tasks.
- Subject line should not end with a period
- body not wrapped at 72 characters: e.g.,
* add assertions to the TaskList constructor to ensure the task list is not null.
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.