Skip to content

Sharing iP code quality feedback [for @fuhlie] #4

Description

@nus-se-script

@fuhlie 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 3aa59a8:


Add an in-app command guide

Users previously had to infer supported syntax from error messages. Add the minimal C-Help extension: a help command that lists every accepted command format and directs unknown commands to that guide.


  • body not wrapped at 72 characters: e.g., Users previously had to infer supported syntax from error messages. Add the minimal C-Help extension: a help command that lists every accepted command format and directs unknown commands to that guide.

possible problems in commit d569743:


Run project checks on GitHub Actions

Local verification does not protect branches after they are pushed. Run the Gradle check task on Linux, macOS, and Windows with the course JDK so failures are visible immediately.


  • body not wrapped at 72 characters: e.g., Local verification does not protect branches after they are pushed. Run the Gradle check task on Linux, macOS, and Windows with the course JDK so failures are visible immediately.

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@nus.edu.sg if you want to follow up on this post.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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