@ryanozx 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
Example from src/main/java/atlas/tasks/Todo.java
lines 28-31
:
/**
* Return string representation of Todo
* @return String representation of Todo
*/
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 b906203
:
Implement ability to set and get reminders
There is no way to display a selection of tasks without specifying a specific date, hence users have to read through
the entire list of tasks to look for "important tasks".
Adding the ability to set and get reminders allows users to see just the important tasks (defined as tasks not complete
and are upcoming).
The option to set a reminder when creating a task hints to Atlas about the task's importance, thus users can be reminded
at the appropriate time.
- body not wrapped at 72 characters: e.g.,
There is no way to display a selection of tasks without specifying a specific date, hence users have to read through
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 [email protected]
if you want to follow up on this post.