ncduy0303 / ip

A desktop app for managing tasks, built as a greenfield project in the CS2103T module at NUS

Alice Task Manager

Alice Task Manager (Alice) is a desktop app for managing tasks, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, she can get your tasks done faster than traditional GUI apps.

This is a greenfield Java project in the CS2103T Software Engineering module, which is part of the curriculum of National University of Singapore (NUS).

Link to the user guide: Alice Task Manager

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/alice/Alice.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:

    ____________________________________________________________
    Hewwo~! I'm Alice
    What can I do for you nyaa~? ˃̵ᴗ˂̵
    ____________________________________________________________
   

ip's Issues

Sharing iP code quality feedback [for @ncduy0303]

@ncduy0303 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/alice/task/Task.java lines 95-99:

    /**
     * Append tags to the task.
     *
     * @param tags The tags to be added.
     */

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 3d7705c:

Improve code quality

Currently, some parts of the code base do not follow the recommended code quality guide

Changes include:
* Remove magic number
* Reduce code duplication in error messages

This will improve future maintenance of the project.

• body not wrapped at 72 characters: e.g., Currently, some parts of the code base do not follow the recommended code quality guide

possible problems in commit 694a4b4:

Enable assertions to `TaskList` to catch potential bugs

Currently, the `TaskList` class methods lack assertions, which means potential bugs could go undetected during runtime, leading to unexpected behaviors and potential data corruption.

The lack of assertions makes the system vulnerable to subtle bugs that can be difficult to detect and diagnose.

Using assertions to catch potential bugs is a proactive approach to software development.

• body not wrapped at 72 characters: e.g., Currently, the TaskList class methods lack assertions, which means potential bugs could go undetected during runtime, leading to unexpected behaviors and potential data corruption.

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 @ncduy0303] - Round 2

@ncduy0303 We did an automated analysis of your code to detect potential areas to improve the code quality. The script did not detect any issues in your code (nice!).

IMPORTANT: Note that the script looked for just a few easy-to-detect problems only 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 Message

No easy-to-detect issues 👍

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.