Skip to content

Sharing iP code quality feedback [for @angjozee] #1

@soc-se-bot-blue

Description

@soc-se-bot-blue

@angjozee 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 Messages

possible problems in commit 320fa80:


Add JUnit tests for AddCommand and Command classes

- Added unit tests for AddCommand to validate ToDo, Deadline, and Event task creation.
- Included tests for valid and invalid date formats and proper exception handling.
- Added tests for Command class behaviour using mock implementations.


  • body not wrapped at 72 characters: e.g., - Added unit tests for AddCommand to validate ToDo, Deadline, and Event task creation.

possible problems in commit 1a2706e:


Organise project into packages for better modularity

- Create packages: command, exception, model, parser, storage, ui, and utils
- Move related classes into corresponding packages:
  - Command classes to command package (AddCommand, DeleteCommand, etc.)
  - Task-related classes to model package (Task, ToDo, Deadline, Event)
  - Parser and exception handling classes to parser and exception packages
  - Storage-related classes to storage package (Storage, PlatoFileWriter)
  - User interaction classes to ui package (Ui)
- Update package declarations and imports across all files


  • body not wrapped at 72 characters: e.g., - Create packages: command, exception, model, parser, storage, ui, and utils

possible problems in commit 5a6b378:


Improve code structure with OOP design and command-based architecture

- Extract task-related logic into individual `Command` classes for maintainability
  - AddCommand: Handles adding ToDo, Deadline, and Event tasks
  - MarkCommand: Handles marking and unmarking tasks
  - DeleteCommand: Handles task deletion
  - ListCommand: Displays the list of tasks
  - ExitCommand: Exits the program
- Introduce an abstract `Command` class to encapsulate command execution logic
- Refactor core logic into `TaskList`, `Storage`, and `Ui` classes to improve modularity


  • body not wrapped at 72 characters: e.g., - Extract task-related logic into individual Command classes for maintainability

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