Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sharing iP code quality feedback [for @potaotototo] - Round 2 #5

Open
soc-se-bot opened this issue Oct 15, 2024 · 0 comments
Open

Sharing iP code quality feedback [for @potaotototo] - Round 2 #5

soc-se-bot opened this issue Oct 15, 2024 · 0 comments

Comments

@soc-se-bot
Copy link

@potaotototo We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

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 Message

possible problems in commit 9702af4:


Add test cases for NoosyDateException and parseEvent method

- Added a unit test to validate NoosyDateException is thrown when an invalid date is provided in the parseDeadline method.
- Added tests for the parseEvent method:
  - Successfully parses valid input with correct date and time format.
  - Throws NoosyException when the duration is incomplete (missing /from or /to).
  - Throws NoosyDateTimeException when the provided date or time is in an invalid format.

These tests improve the robustness of the Parser class by ensuring error handling is properly implemented for date and time-related inputs.


  • body not wrapped at 72 characters: e.g., - Added a unit test to validate NoosyDateException is thrown when an invalid date is provided in the parseDeadline method.

possible problems in commit b38b91f:


Merge branch 'master' of https://github.com/potaotototo/ip
Merge all three branches


  • No blank line between subject and body

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 👍


❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant