Skip to content

Sharing iP code quality feedback [for @jamesberyl] #3

Description

@soc-se-bot-blue

@jamesberyl 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/nimbus/ui/UI.java lines 119-119:

        boolean found = 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

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 2ac0e2e:


Implement chronological sorting for tasks

Previously, tasks in Nimbus were just listed in the order they were added, which made it hard to figure out what needed attention first. Deadlines could get lost in the list, and events wouldn’t always show up in the right order.

Without sorting, users had to manually scan through their tasks to see which had the highest priority. This made planning and staying on top of things harder.

Now, tasks are sorted chronologically:
* Events come first, sorted by their start time. If two events start at the same time, they’re ordered by end time.
* Deadlines follow, sorted by due date.
* Todos, which don’t have deadlines, are placed in the order they were created.

This update makes it much easier to see what’s coming up next, helping users stay organised without extra effort.


  • body not wrapped at 72 characters: e.g., Previously, tasks in Nimbus were just listed in the order they were added, which made it hard to figure out what needed attention first. Deadlines could get lost in the list, and events wouldn’t always show up in the right order.

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions