ktzy0305/ip

Skye project template

This is a project template for a greenfield Java project. It's named after the Java mascot Duke. Given below are instructions on how to use it.

Setting up in Intellij

Prerequisites: JDK 11, update Intellij to the most recent version.

1. Open Intellij (if you are not in the welcome screen, click File > Close Project to close the existing project first)
2. Open the project into Intellij as follows:
   1. Click Open.
   2. Select the project directory, and click OK.
   3. If there are any further prompts, accept the defaults.
3. Configure the project to use JDK 11 (not other versions) as explained in here.
   In the same dialog, set the Project language level field to the SDK default option.
4. After that, locate the src/main/java/skye.Skye.java file, right-click it, and choose Run skye.Skye.main() (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:

   Hello from
    ____        _        
   |  _ \ _   _| | _____ 
   | | | | | | | |/ / _ \
   | |_| | |_| |   <  __/
   |____/ \__,_|_|\_\___|
   

ip's Issues

Sharing iP code quality feedback [for @ktzy0305]

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

Example from src/main/java/skye/Skye.java lines 51-53:

    /**
     * A method to start running the chatbot.
     */

Example from src/main/java/skye/Skye.java lines 76-79:

    /**
     * You should have your own function to generate a response to user input.
     * Replace this stub with your completed method.
     */

Example from src/main/java/skye/data/TaskList.java lines 60-66:

    /**
     * Mark a task as completed by specifying the task number.
     *
     * @param taskNumber The numerical order of the task in the list.
     * @return The task that was marked as completed
     * @throws DukeException if taskNumber < 1 or taskNumber > number of tasks
     */

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 882e988:

Improve code quality and fix coding standard violations

Improvements were made to the code quality of the existing code base.

Coding standard violations regarding indentation of wrapped lines and javadoc comments were identified.

A summary of what was done
* Ensure that wrapped lines are indented by 8 spaces.
* Ensure all naming complies with coding standards
* Removal of dead code

• body not wrapped at 72 characters: e.g., Coding standard violations regarding indentation of wrapped lines and javadoc comments were identified.

Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).

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 [email protected] if you want to follow up on this post.

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

@ktzy0305 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/skye/data/TaskList.java lines 78-84:

    /**
     * Unmark a completed task by specifying the task number.
     *
     * @param taskNumber The numerical order of the task in the list.
     * @return The task that was unmarked
     * @throws DukeException if taskNumber < 1 or taskNumber > number of tasks
     */

Example from src/main/java/skye/data/TaskList.java lines 96-102:

    /**
     * Delete a task
     *
     * @param taskNumber The numerical order of the task in the list.
     * @return The task that was deleted
     * @throws DukeException if taskNumber < 1 or taskNumber > number of tasks
     */

Example from src/main/java/skye/data/VenueList.java lines 58-64:

    /**
     * Delete a venue
     *
     * @param venueNumber The numerical order of the venue in the list.
     * @return The venue that was deleted
     * @throws DukeException if venueNumber < 1 or venueNumber > number of venues
     */

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

No easy-to-detect issues 👍

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.