Sharing iP code quality feedback [for @nayanaamahesh]

@nayanaamahesh 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 :+1:

Aspect: Naming boolean variables/methods

Example from src/main/java/nayana/task/Task.java lines 9-9:


    private boolean done;

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 :+1:

Aspect: Package Name Style

No easy-to-detect issues :+1:

Aspect: Class Name Style

No easy-to-detect issues :+1:

Aspect: Dead Code

No easy-to-detect issues :+1:

Aspect: Method Length

No easy-to-detect issues :+1:

Aspect: Class size

No easy-to-detect issues :+1:

Aspect: Header Comments

No easy-to-detect issues :+1:

Aspect: Recent Git Commit Message

possible problems in commit a4ffb7a:


Merge branch 'master' of github.com:nayanaamahesh/ip

* 'master' of github.com:nayanaamahesh/ip:
  Subject: Refactor Remind and Find methods to use Streams Body: Refactored the Remind and Find methods to utilize Java Streams for improved readability and performance.

body not wrapped at 72 characters: e.g., Subject: Refactor Remind and Find methods to use Streams Body: Refactored the Remind and Find methods to utilize Java Streams for improved readability and performance.

possible problems in commit a5b2f50:


Merge branch 'master' of github.com:nayanaamahesh/ip

* 'master' of github.com:nayanaamahesh/ip:
  Subject: Add Reminder feature for upcoming tasks Body: Introduced a new Reminder feature that alerts users about tasks due within the upcoming week. This enhancement automatically checks for deadlines and events scheduled in the next seven days, providing a proactive notification to help users stay on track.The feature was added to improve task management and ensure that users don't miss important deadlines. It integrates seamlessly with the existing task list, parsing, and GUI, and is triggered each time the user keys in "remind". This feature enhances user productivity and supports better planning by keeping upcoming tasks visible.

body not wrapped at 72 characters: e.g., Subject: Add Reminder feature for upcoming tasks Body: Introduced a new Reminder feature that alerts users about tasks due within the upcoming week. This enhancement automatically checks for deadlines and events scheduled in the next seven days, providing a proactive notification to help users stay on track.The feature was added to improve task management and ensure that users don't miss important deadlines. It integrates seamlessly with the existing task list, parsing, and GUI, and is triggered each time the user keys in "remind". This feature enhances user productivity and supports better planning by keeping upcoming tasks visible.

possible problems in commit 4a24ded:


Subject:
Refactor Remind and Find methods to use Streams
Body:
Refactored the Remind and Find methods to utilize Java Streams for improved readability and performance.

Changes:
Remind Method: Replaced traditional loops with Stream API operations to filter and collect upcoming tasks due within the week. This enhances the clarity and efficiency of the code.
Find Method: Converted the search logic to use Streams for a more concise and expressive approach to task filtering based on search criteria.

Using Streams not only simplifies the code but also leverages modern Java features for better performance and maintainability. This refactoring supports a more functional programming style and aligns with current best practices.

No blank line between subject and body
body not wrapped at 72 characters: e.g., Refactored the Remind and Find methods to utilize Java Streams for improved readability and performance.

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 :+1:

:information_source: 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.

nayanaamahesh / ip