Link: https://nus-cs2103-ay2021s1.github.io/website/schedule/week3/project.html#a-junit

Add JUnit tests to test the behavior of the code.

Requirements:

Minimum: More than two test methods, preferably targeting more than one class (if you have multiple classes)
Stretch goal: test methods to target all public methods of all classes
Refer to the JUnit tutorial @se-edu/guides to find how to use JUnit.

Add JavaDoc comments

Add JavaDoc comments to the code.

Minimal: Add header comments to at least half of the non-private classes/methods.
Stretch goal: Add header comments to all non-private classes/methods, and non-trivial private methods.

Provide a way to tag items e.g., tag a task as #fun.

A-Gradle
↳ Automate project builds using Gradle

Use Gradle to automate some of the build tasks of the project.

Refer to the Gradle tutorial @se-edu to learn how to use Gradle.

Gradle support is provided as a separate branch (named add-gradle-support) in the Duke repo. Therefore, you can follow the scenario 2 in the above guide.

Minimal: Set up gradle so that you can build and run Duke using gradle.
Recommended: Set up gradle to run unit tests.
Stretch Goal: Use gradle to automate more things in your project.

Critically examines the code and refactor to improve the code quality where necessary.

When adding this increment, follow closely the 'Code Quality' topics you have learned so far, rather than merely follow your own intuition about code quality.

Teach Duke how to understand dates and times. For example, if the command is deadline return book /by 2/12/2019 1800, Duke should understand 2/12/2019 1800 as 2nd of December 2019, 6pm, instead of treating it as just a String.

Minimal: Store deadline dates as a java.time.LocalDate in your task objects. Accept dates in a format such as yyyy-mm-dd format (e.g., 2019-10-15) and print in a different format such as MMM dd yyyy e.g., (Oct 15 2019).
Stretch goal: Use dates and times in more meaningful ways. e.g., add a command to print deadlines/events occurring on a specific date.

Link: https://nus-cs2103-ay2021s1.github.io/website/schedule/week3/project.html#a-moreoop

Refactor the code to extract out closely related code as classes.

Minimal: Extract the following classes:
Ui: deals with interactions with the user
Storage: deals with loading tasks from the file and saving tasks in the file
Parser: deals with making sense of the user command
TaskList: contains the task list e.g., it has operations to add/delete tasks in the list
For example, the code of the main class could look like this:

public class Duke {

private Storage storage;
private TaskList tasks;
private Ui ui;

public Duke(String filePath) {
    ui = new Ui();
    storage = new Storage(filePath);
    try {
        tasks = new TaskList(storage.load());
    } catch (DukeException e) {
        ui.showLoadingError();
        tasks = new TaskList();
    }
}

public void run() {
    //...
}

public static void main(String[] args) {
    new Duke("data/tasks.txt").run();
}

}
Stretch Goal: Consider extracting more classes. e.g., *Command classes (i.e., AddCommand, DeleteCommand, ExitCommand etc.) that inherits from an abstract Command class, so that you can write the main logic of the App as follows:
public void run() {
ui.showWelcome();
boolean isExit = false;
while (!isExit) {
try {
String fullCommand = ui.readCommand();
ui.showLine(); // show the divider line ("_______")
Command c = Parser.parse(fullCommand);
c.execute(tasks, ui, storage);
isExit = c.isExit();
} catch (DukeException e) {
ui.showError(e.getMessage());
} finally {
ui.showLine();
}
}
}
You can get some inspiration from how the code of the addressbook-level2 is organized.

A-CheckStyle
↳ Use CheckStyle

Use checkStyle to detect coding style violations.

Refer the tutorial Using Checkstyle @SE-EDU/guides to learn how to use Checkstyle.

Divide classes into packages

Organize the classes into suitable java packages.

Minimal: put all classes in one package e.g., duke
Stretch goal: divide into multiple packages as the number of classes increase e.g., duke.task, duke.command

Tweak the code to comply with a given coding standard. From this point onward, ensure any new code added are compliant with the given coding standard.

Level 10. GUI
Add a GUI to Duke. Use the JavaFX technology to implement the GUI.

Refer to the JavaFX tutorial @SE-EDU/guides to learn how to get started with JavaFX.

Nice to see you've done some extra stuff on the release notes etc. Keep up the good work 👍

Link: https://nus-cs2103-ay2021s1.github.io/website/schedule/week3/project.html#a-jar

Package the app as an executable JAR file so that it can be distributed easily.

You can assume the user will run the jar file in the following way only:

Copy the jar file into an empty folder
Open a command window in that folder
Run the command java -jar {filename}.jar e.g., java -jar Duke.jar (i.e., run the command in the same folder as the jar file)
Refer to the tutorial Working with JAR files @SE-EDU/guides to find how to create JAR files.

Do not commit the JAR file created. Instead, you can make the JAR file available in the following manner.

Go to your fork on GitHub and create a new release.
In the page where you fill the details of th release,
give an appropriate version number e.g., v0.1
attach the JAR file where it says Attach binaries by dropping them ....

A-Varargs
↳ Use var-args

Use Java varargs feature, if applicable.

Link: https://nus-cs2103-ay2021s1.github.io/website/schedule/week3/project.html#level-9-find

Give users a way to find a task by searching for a keyword.

Example:

find book
    ____________________________________________________________
     Here are the matching tasks in your list:
     1.[T][✓] read book
     2.[D][✓] return book (by: June 6th)

Level 7. Save

Link: https://nus-cs2103-ay2021s1.github.io/website/schedule/week3/project.html#level-7-save

• Save the tasks in the hard disk automatically whenever the task list changes. Load the data from the hard disk when Duke starts up.
• You may hard-code the file name and location e.g., [project_root]/data/duke.txt

The format of the file is up to you. Example:

T | 1 | read book
D | 0 | return book | June 6th
E | 0 | project meeting | Aug 6th 2-4pm
T | 1 | join sports club

Your code must handle the case where the file doesn't exist at the start. Reason: when someone else takes your Duke and runs it for the first time, the required file might not exist in their computer. Similarly, if you expect the data file to be in as specific folder (e.g., ./data/), you must also handle the 'folder does not exist yet' case.

Add a User Guide to the project. Here is one simple way to do it.

Update the given docs\README.md. See this guide to GitHub flavored Markdown (GFMD).
Go to the settings page of your Duke fork and enable GitHub pages to publish from the docs folder (you can select a theme too).
Go to http://{your username}.github.io/{repo name}/ to view the user guide of your product. Note: it could take 5-10 minutes for GitHub to update the page.

Use assert feature (not JUnit assertions) to document important assumptions that should hold at various points in the code.