Sharing iP code quality feedback [for @markgcera] - Round 2

[soc-se-script]

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

Example from src/main/java/contentsplitter/DeadlineContentSplitter.java lines 20-23:

    /**
     *  This method returns the description.
     * @return the description of this task.
     */

Example from src/main/java/contentsplitter/DeadlineContentSplitter.java lines 28-31:

    /**
     *  This method returns the date.
     * @return the date of the deadline.
     */

Example from src/main/java/contentsplitter/EventContentSplitter.java lines 23-26:

    /**
     *  This method returns the description.
     * @return the description of this task.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

Aspect: Recent Git Commit Message

possible problems in commit 14743c9:

Extract out the duplicate tester and add error handling for it.

• Subject line should not end with a period

possible problems in commit f974522:

Refactor the AddWorker class to add more abstraction to make the code cleaner.

• Longer than 72 characters
• Subject line should not end with a period

possible problems in commit cda1cc0:

Add an opening message.

• Subject line should not end with a period

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.