nekrozqliphort / ip Goto Github PK

This project forked from nus-cs2103-ay2122s1/ip

Java 94.93% Batchfile 1.79% Shell 2.47% CSS 0.81%

ip's Introduction

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.

Open Intellij (if you are not in the welcome screen, click File > Close Project to close the existing project first)
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.
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.
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 from
 ____        _        
|  _ \ _   _| | _____ 
| | | | | | | |/ / _ \
| |_| | |_| |   <  __/
|____/ \__,_|_|\_\___|
```

ip's People

Contributors

ip's Issues

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

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/duke/CommandParser.java lines 17-23:

    /**
     * Parse the given line from the CLI and returns an array of commands and arguments.
     *
     * @param cmd Line from the CLI.
     * @return An array representing the command and arguments.
     * @throws DukeException If the command is invalid or has invalid arguments.
     */

Example from src/main/java/duke/Duke.java lines 151-156:

    /**
     * Return the response of duke after receiving the input.
     *
     * @param input The input to be parsed into a command and executed.
     * @return The response after executing the command.
     */

Example from src/main/java/duke/Duke.java lines 168-172:

    /**
     * Launch the Duke application.
     *
     * @param args Ignored parameters.
     */

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 (Subject Only)

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 @nus-se-bot 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 @NekrozQliphort]

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 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: Header Comments

Example from src/main/java/duke/CommandParser.java lines 17-23:

    /**
     * Parse the given line from the CLI and returns an array of commands and arguments.
     *
     * @param cmd Line from the CLI.
     * @return An array representing the command and arguments.
     * @throws DukeException If the command is invalid or has invalid arguments.
     */

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 (Subject Only)

No easy-to-detect issues 👍

ℹ️ The bot account @cs2103-bot 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.

nekrozqliphort / ip Goto Github PK

ip's Introduction

Duke project template

Setting up in Intellij

ip's People

Contributors

ip's Issues

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message (Subject Only)

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Header Comments

Aspect: Recent Git Commit Message (Subject Only)

Recommend Projects

Recommend Topics

Recommend Org