Sharing iP code quality feedback [for @awc1116]

[nus-se-bot]

@awc1116 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

Example from src/main/java/Doopies/notebook/Task.java lines 16-16:

    private final 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 👍

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 a1c6a8b:

Add reminders functionality

Once you start the app, all not done (todo, deadline due within one day,
event starting within one day will be gathered and pop out as a reminder).
User can also type in the word reminders to get the reminders

1. Added a getTasksDueWithinOneDay method in Notebooks to get the reminders task.
2. Parser including a like from a "reminders" command from user.
3. Added a RemindersCommand to accept the "reminders" command and execute the necessary tasking.

• body not wrapped at 72 characters: e.g., event starting within one day will be gathered and pop out as a reminder).

possible problems in commit e7e5f64:

Add javaDocs for showWelcome() under doopies.userinterface.MainWindow.java

• Longer than 72 characters

possible problems in commit d229286:

Enhance GUI & Fix Scrolling in Doopies App

1.  UI Improvements: Added title bar with centered "Doopies" label and circular logo.
2. Scroll Pane Fixes: Enabled mouse wheel scrolling by simulating click + drag.

• body not wrapped at 72 characters: e.g., 1. UI Improvements: Added title bar with centered "Doopies" label and circular logo.

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.