darkarche3 / ip

Duke 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/Duke.java file, right-click it, and choose Run Duke.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! I'm Area. What can I do for you?

ip's Issues

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

@Darkarche3 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/area/Storage.java lines 25-31:

    /**
     * The Storage class manages files operations for storing and retrieving
     * task data.
     * It handles the interaction with the data files where tasks are located.
     * 
     * @param tasks List 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 1e5f67c:

Update Javadocs

Updated javadocs so that all methods and classes had their respective javadocs comments.

• body not wrapped at 72 characters: e.g., Updated javadocs so that all methods and classes had their respective javadocs comments.

possible problems in commit 524ea4c:

Update Parser.java

Changed parsePriority method to return error message based on incorrect input

Update parsePriority method

• body not wrapped at 72 characters: e.g., Changed parsePriority method to return error message based on incorrect input

possible problems in commit ec85b9b:

Update Readme.md

Readme is incomplete.

Updating Readme allows for user to understand how to use the chatbot.

Update Readme by adding features of chatbot such as the commands.

This is to make it easy and direct for users to understand what commands the chatbot can follow.

• body not wrapped at 72 characters: e.g., This is to make it easy and direct for users to understand what commands the chatbot can follow.

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.

Sharing iP code quality feedback [for @Darkarche3]

@Darkarche3 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/area/Area.java lines 77-82:

    /**
     * main to start chatbot program
     * 
     * @param args
     * @throws Exception
     */

Example from src/main/java/area/Storage.java lines 25-30:

    /**
     * Return an object of type Storage
     * 
     * @param path
     * @param tasks
     */

Example from src/main/java/area/Storage.java lines 39-43:

    /**
     * Add an instruction to a list of instructions
     * 
     * @param instruction
     */

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 51a023b:

Update to Comments

Updated comments to follow Coding standards to ensure it is easy to read for others.

• body not wrapped at 72 characters: e.g., Updated comments to follow Coding standards to ensure it is easy to read for others.

possible problems in commit f50c691:

Add find method

The find method will help make it possible to quickly search for certain task based on keywords.

• body not wrapped at 72 characters: e.g., The find method will help make it possible to quickly search for certain task based on keywords.

possible problems in commit 5fb1769:

Update coding standard

Following Git conventions can help make it easier to understand and follow the codebase.

Any changes made will also be easy to understand.

• body not wrapped at 72 characters: e.g., Following Git conventions can help make it easier to understand and follow the codebase.

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