DeveloperGuide.adoc

Your TA - Developer Guide

By: F09-B1      Since: Jun 2016      Licence: MIT

• 1. Introduction
• 2. How to contribute to Your TA?
  • 2.1. New Developers
  • 2.2. Experienced Developers
• 3. Setting up
  • 3.1. Prerequisites
  • 3.2. Setting up the project in your computer
  • 3.3. Verifying the setup
  • 3.4. Configurations to do before writing code
• 4. Design
  • 4.1. Architecture
  • 4.2. Login Component
  • 4.3. UI component
  • 4.4. Logic component
  • 4.5. Model component
  • 4.6. Storage component
  • 4.7. Common classes
• 5. Implementation
  • 5.1. Help feature
  • 5.2. Undo/Redo feature
  • 5.3. [Proposed] Data Encryption (Coming in v2.0)
  • 5.4. Email (Since v1.1)
  • 5.5. Display Picture (Since v1.2)
  • 5.6. Logging
  • 5.7. Configuration
• 6. Documentation
  • 6.1. Editing Documentation
  • 6.2. Publishing Documentation
  • 6.3. Converting Documentation to PDF format
• 7. Testing
  • 7.1. Running Tests
  • 7.2. Types of tests
  • 7.3. Troubleshooting Testing
• 8. Dev Ops
  • 8.1. Build Automation
  • 8.2. Continuous Integration
  • 8.3. Coverage Reporting
  • 8.4. Documentation Previews
  • 8.5. Making a Release
  • 8.6. Managing Dependencies
• Appendix A: Product Scope
  • A.1. Feature contribution
• Appendix B: User Stories
• Appendix C: Use Cases
• Appendix D: Non Functional Requirements
• Appendix E: Glossary
• Appendix F: Product Survey
• Appendix G: Instructions for Manual Testing
  • G.1. Launch and Shutdown
  • G.2. Deleting a person
  • G.3. Saving data

1. Introduction

Your TA is an address book application designed to amplify the capabilities of a university teaching assistant or tutor. It aims to provide all the essential functions needed to manage the administrative duties of handling a class as well as to aid the tutor to better connect with the class. It includes a calendar, scheduling capabilities, as well as the ability to mark attendance and participation as well.

2. How to contribute to Your TA?

2.1. New Developers

You may wish to refer to the setting up portion to set up the Your TA project file.

Read through the rest of the guide to familiarise yourself with how Your TA components functions together.

Try making some enhancements or edits to a component and make a Pull Request (PR) to our repo! We will take a look at your PR and give you some feedback or even merge your code if it’s great.

2.2. Experienced Developers

The Developer Guide contains the design of the models that make up the program. Each section also details how each and every functionality is implemented and how it interacts with the different models. We would greatly appreciate your help in fine-tuning the components and also welcome any suggestions or feedback to improve Your TA.

3. Setting up

3.1. Prerequisites

The following are essential programs and libraries needed to start developing Your TA.

1. JDK 1.8.0_60 or later

   ℹ️	Having any Java 8 version is not enough. This app will not work with earlier versions of Java 8.

2. IntelliJ IDE

   ℹ️	IntelliJ by default has Gradle and JavaFx plugins installed. Do not disable them. If you have disabled them, go to File > Settings > Plugins to re-enable them.

3. Sufficient Java and Javafx knowledge

   ℹ️	This application is written in Java and Javafx. A good amount of experience with the language (about 10k lines of code written in Java and Javafx) is required to understand and work in the application.

3.2. Setting up the project in your computer

Please follow the steps below to download and set up the project.

1. Fork this repository, and clone the fork to your computer.

2. Open IntelliJ (if you are not in the welcome screen, click File > Close Project to close the existing project dialog first).

3. Set up the correct JDK version for Gradle.

   1. Click Configure > Project Defaults > Project Structure.

   2. Click New…​ and find the directory of the JDK.

4. Click Import Project.

5. Locate the build.gradle file and select it. Click OK.

6. Click Open as Project.

7. Click OK to accept the default settings.

8. Open a console and run the command gradlew processResources (Mac/Linux: ./gradlew processResources). It should finish with the BUILD SUCCESSFUL message.
   This will generate all resources required by the application and tests.

3.3. Verifying the setup

Run the following steps to ensure that you successfully set up the project.

1. Run the seedu.address.MainApp and try a few commands.

2. Run the tests to ensure they all pass.

You should see in the console that all the tests have successfully completed.

3.4. Configurations to do before writing code

The following configurations should be set up before you start coding to ensure a uniform coding style.

3.4.1. Configuring the coding style

This project follows oss-generic coding standards. IntelliJ’s default style is mostly compliant with ours but it uses a different import order from ours. To rectify,

1. Go to File > Settings…​ (Windows/Linux), or IntelliJ IDEA > Preferences…​ (macOS)

2. Select Editor > Code Style > Java

3. Click on the Imports tab to set the order

   • For Class count to use import with '*' and Names count to use static import with '*': Set to 999 to prevent IntelliJ from contracting the import statements

   • For Import Layout: The order is import static all other imports, import java.*, import javax.*, import org.*, import com.*, import all other imports. Add a <blank line> between each import

Optionally, you can follow the UsingCheckstyle.adoc document to configure Intellij to check style-compliance as you write code.

3.4.2. Updating documentation to match your fork

After forking the repo, links in the documentation will still point to the CS2103JAN2018-F09-B1/main repository. If you plan to develop this as a separate product (i.e. instead of contributing to the CS2103JAN2018-F09-B1/main) , you should replace the URL in the variable repoURL in DeveloperGuide.adoc and UserGuide.adoc with the URL of your fork.

3.4.3. Setting up CI

Set up Travis to perform Continuous Integration (CI) for your fork. See UsingTravis.adoc to learn how to set it up.

After setting up Travis, you can optionally set up coverage reporting for your team fork (see UsingCoveralls.adoc).

ℹ️	Coverage reporting could be useful for a team repository that hosts the final version but it is not that useful for your personal fork.

Optionally, you can set up AppVeyor as a second CI (see UsingAppVeyor.adoc).

ℹ️	Having both Travis and AppVeyor ensures your App works on both Unix-based platforms and Windows-based platforms (Travis is Unix-based and AppVeyor is Windows-based)

3.4.4. Getting started with coding

When you are ready to start coding,

1. Get some sense of the overall design by reading Section 4.1, “Architecture”.

2. Take a look at [GetStartedProgramming].

4. Design

This section will present to you the high-level design view of Your TA.

4.1. Architecture

Figure 1. Architecture Diagram

The Architecture Diagram given above explains the high-level design of the App. Given below is a quick overview of each component.

💡	The .pptx files used to create diagrams in this document can be found in the diagrams folder. To update a diagram, modify the diagram in the pptx file, select the objects of the diagram, and choose Save as picture.

Main has only one class called MainApp. It is responsible for:

• Initializes the components in the correct sequence at the app launch, and connects them up with each other.

• Shutting down the components and invokes cleanup method where necessary.

Commons represents a collection of classes used by multiple other components. Two of those classes play important roles at the architecture level.

• EventsCenter : This class (written using Google’s Event Bus library) is used by components to communicate with other components using events (i.e. a form of Event Driven design)

• LogsCenter : Used by many classes to write log messages to the App’s log file.

The rest of the App consists of five components.

• Login: Authenticates access to App.

• UI: The UI of the App.

• Logic: The command executor.

• Model: Holds the data of the App in-memory.

• Storage: Reads data from, and writes data to, the hard disk.

Each of the last four components

• Defines its API in an interface with the same name as the Component.

• Exposes its functionality using a {Component Name}Manager class.

For example, the Logic component (see the class diagram given below) defines it’s API in the Logic.java interface and exposes its functionality using the LogicManager.java class.

Figure 2. Class Diagram of the Logic Component

Events-Driven nature of the design

The Sequence Diagram below shows how the components interact for the scenario where the user issues the command delete 1.

Figure 3. Component interactions for delete 1 command (part 1)

ℹ️	Note how the Model simply raises a AddressBookChangedEvent when the Address Book data are changed, instead of asking the Storage to save the updates to the hard disk.

The diagram below shows how the EventsCenter reacts to that event, which eventually results in the updates being saved to the hard disk and the status bar of the UI being updated to reflect the 'Last Updated' time.

Figure 4. Component interactions for delete 1 command (part 2)

ℹ️	Note how the event is propagated through the EventsCenter to the Storage and UI without Model having to be coupled to either of them. This is an example of how this Event Driven approach helps us reduce direct coupling between components.

The sections below give more details of each component.

4.2. Login Component

Figure 5. Interactions for Login Component

Upon launching the app, the Login component takes in two inputs from the user: Username and Password, then stores the user’s login credentials into a .xml file. [Optional] .xml file is encrypted.

• The login credentials are therefore immutable (cannot be changed).

• The same username and password have to be used every time the user wishes to access the app.

• Only upon successful authentication will the app load data from the Storage Component.

4.3. UI component

Figure 6. Structure of the UI Component

API : Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, TodoListPanel, StatusBarFooter, CalendarView etc. All these, including the MainWindow, inherit from the abstract UiPart class.

Figure 7. Layout of the UI

As seen above is the current layout of the UI.

The UI component uses JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

The UI component loads the layout of each part from the .fxml file and then does the bindings to various variables in the address book model in the corresponding .java file.

ℹ️	It may be difficult to edit the .fxml file directly. Javafx Scene Builder is recommended to be used to edit or create new .fxml files.

The UI component:

• Executes user commands using the Logic component.

• Binds itself to some data in the Model so that the UI can auto-update when data in the Model change.

• Responds to events raised from various parts of the App and updates the UI accordingly.

4.4. Logic component

The diagram below shows how the LogicManager functions in the application.

Figure 8. Structure of the Logic Component

The diagram below shows finer details concerning XYZCommand and Command in Figure 8, “Structure of the Logic Component”

API : Logic.java

1. Logic uses the AddressBookParser class to parse the user command.

2. This results in a Command object which is executed by the LogicManager.

3. The command execution can affect the Model (e.g. adding a person) and/or raise events.

4. The result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui.

Given below is the Sequence Diagram for interactions within the Logic component for the execute("delete 1") API call.

Figure 9. Interactions Inside the Logic Component for the delete 1 Command

4.5. Model component

The diagram below shows the different components and interfaces that make up the Model component.

Figure 10. Structure of the Model Component

API : Model.java

The Model:

• Stores a UserPref object that represents the user’s preferences.

• Stores the Address Book data.

• Exposes an unmodifiable ObservableList<Person> that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.

• Does not depend on any of the other three components.

The Person Class:

• Stores the information of a specific person (student) in the AddressBook

• Information includes: Name, Matriculation Number, Phone Number, Email, Address and different tags to associate with that person.

• Implements UniquePersonList that enforces uniqueness of its elements and disallows nulls.

• Name: Object that stores the name of the Person Object.

  ℹ️	Person’s name should only contain alphanumeric characters, and should not be null.

• Matriculation Number: Object that stores the matriculation number of the Person Object.

  ℹ️	Matriculation number should start with either 'A' or 'U', followed by 7 digits and ending with an alphabet (A-Z).

• Phone Number: Object that stores the phone number of the Person Object.

• Email: Object that stores the email address of the Person Object.

  ℹ️	Email address should be of the format local-part@domain.

The Tag Class,

• An immutable object that has to be valid.

• Checks are implemented to guarantee validity.

  💡	For every Person object, there can be multiple (or zero) tags.

4.6. Storage component

Figure 11. Structure of the Storage Component

API : Storage.java

The Storage component:

• can save UserPref objects in json format and read it back.

• can save the Address Book data in xml format and read it back.

4.7. Common classes

Classes used by multiple components are in the seedu.addressbook.commons package.

5. Implementation

This section describes some noteworthy details on how certain features are implemented.

5.1. Help feature

5.1.1. Current Implementation

The help command opens a new window, opening the user guide.

5.2. Undo/Redo feature

5.2.1. Current Implementation

The undo/redo mechanism is facilitated by an UndoRedoStack, which resides inside LogicManager. It supports undoing and redoing of commands that modifies the state of the address book (e.g. add, edit). Such commands will inherit from UndoableCommand.

UndoRedoStack only deals with UndoableCommands. Commands that cannot be undone will inherit from Command instead. The following diagram shows the inheritance diagram for commands:

As you can see from the diagram, UndoableCommand adds an extra layer between the abstract Command class and concrete commands that can be undone, such as the DeleteCommand. Note that extra tasks need to be done when executing a command in an undoable way, such as saving the state of the address book before execution. UndoableCommand contains the high-level algorithm for those extra tasks while the child classes implements the details of how to execute the specific command. Note that this technique of putting the high-level algorithm in the parent class and lower-level steps of the algorithm in child classes is also known as the template pattern.

Commands that are not undoable are implemented this way:

public class ListCommand extends Command {
    @Override
    public CommandResult execute() {
        // ... list logic ...
    }
}

With the extra layer, the commands that are undoable are implemented this way:

public abstract class UndoableCommand extends Command {
    @Override
    public CommandResult execute() {
        // ... undo logic ...

        executeUndoableCommand();
    }
}

public class DeleteCommand extends UndoableCommand {
    @Override
    public CommandResult executeUndoableCommand() {
        // ... delete logic ...
    }
}

Suppose that the user has just launched the application. The UndoRedoStack will be empty at the beginning.

The user executes a new UndoableCommand, delete 5, to delete the 5th person in the address book. The current state of the address book is saved before the delete 5 command executes. The delete 5 command will then be pushed onto the undoStack (the current state is saved together with the command).

As the user continues to use the program, more commands are added into the undoStack. For example, the user may execute add n/David …​ to add a new person.

ℹ️	If a command fails its execution, it will not be pushed to the UndoRedoStack at all.

The user now decides that adding the person was a mistake, and decides to undo that action using undo.

We will pop the most recent command out of the undoStack and push it back to the redoStack. It would then proceed to restore the address book to the state before the add command executed.

ℹ️	If the undoStack is empty, then there are no other commands left to be undone, and an Exception will be thrown when popping the undoStack.

The following sequence diagram shows how the undo operation works:

The redo does the exact opposite (pops from redoStack, push to undoStack, and restores the address book to the state after the command is executed).

ℹ️	If the redoStack is empty, then there are no other commands left to be redone, and an Exception will be thrown when popping the redoStack.

The user now decides to execute a new command, clear. As before, clear will be pushed into the undoStack. This time the redoStack is no longer empty. It will be purged as it no longer make sense to redo the add n/David command (this is the behavior that most modern desktop applications follow).

Commands that are not undoable are not added into the undoStack. For example, list, which inherits from Command rather than UndoableCommand, will not be added after execution:

The following activity diagram summarize what happens inside the UndoRedoStack when a user executes a new command:

5.2.2. Design Considerations

Aspect: Implementation of UndoableCommand

• Alternative 1 (current choice): Add a new abstract method executeUndoableCommand()

  • Pros: We will not lose any undone/redone functionality as it is now part of the default behaviour. Classes that deal with Command do not have to know that executeUndoableCommand() exist.

  • Cons: Hard for new developers to understand the template pattern.

• Alternative 2: Just override execute()

  • Pros: Does not involve the template pattern, easier for new developers to understand.

  • Cons: Classes that inherit from UndoableCommand must remember to call super.execute(), or lose the ability to undo/redo.

Aspect: How undo & redo executes

• Alternative 1 (current choice): Saves the entire address book.

  • Pros: Easy to implement.

  • Cons: May have performance issues in terms of memory usage.

• Alternative 2: Individual command knows how to undo/redo by itself.

  • Pros: Will use less memory (e.g. for delete, just save the person being deleted).

  • Cons: We must ensure that the implementation of each individual command are correct.

Aspect: Type of commands that can be undone/redone

• Alternative 1 (current choice): Only include commands that modifies the address book (add, clear, edit).

  • Pros: We only revert changes that are hard to change back (the view can easily be re-modified as no data are * lost).

  • Cons: User might think that undo also applies when the list is modified (undoing filtering for example), * only to realize that it does not do that, after executing undo.

• Alternative 2: Include all commands.

  • Pros: Might be more intuitive for the user.

  • Cons: User have no way of skipping such commands if he or she just want to reset the state of the address * book and not the view. Additional Info: See our discussion here.

Aspect: Data structure to support the undo/redo commands

• Alternative 1 (current choice): Use separate stack for undo and redo

  • Pros: Easy to understand for new Computer Science student undergraduates to understand, who are likely to be * the new incoming developers of our project.

  • Cons: Logic is duplicated twice. For example, when a new command is executed, we must remember to update * both HistoryManager and UndoRedoStack.

• Alternative 2: Use HistoryManager for undo/redo

  • Pros: We do not need to maintain a separate stack, and just reuse what is already in the codebase.

  • Cons: Requires dealing with commands that have already been undone: We must remember to skip these commands. Violates Single Responsibility Principle and Separation of Concerns as HistoryManager now needs to do two * different things.

5.3. [Proposed] Data Encryption (Coming in v2.0)

{Explain here how the data encryption feature will be implemented}

5.4. Email (Since v1.1)

This feature allows the user to call their desktop mail application from the application itself, with the mailTo: field already populated with the user input.

5.4.1. Current implementation

Figure 3.3.1: Email Implementation

The user will enter a command email 1 to the application. The application will then rely on AddressBookparser and EmailCommandParser to parse the argument. The argument will be passed into the EmailCommand when it will be checked on whether the argument is valid. From there, it will call the Java Desktop class to launch the user’s default mail application.

5.4.2. Design Considerations

Aspect: How the email is sent

• Alternative 1 (current choice): Use the Java Desktop class to open the default mail app

  • Pros: It is fast and works with supported Desktop and OS.

  • Cons: Does not work on systems wihtout a default Desktop mail application.

• Alternative 2: Use the in-built browser

  • Pros: Higher level of compatibility, means it can be used with a wider range of operating systems.

  • Cons: Clunky as users may use different web mail services. The API would also differ based on the email they use as well.

5.4.3. Future enhancements (Coming in v1.3)

Support for writing the subject title in the application as well by adding an extra parameter such as email 1 s/ [SUBJECT].

5.5. Display Picture (Since v1.2)

This feature allows the user to enter a path to their selected image file and copies the image into the images\displayPic folder. This image will be shown in the application next to the details of the person.

5.5.1. Current implementation

The application will take in the argument through dp/ [PATH TO IMAGE]. If this is empty, the application will default to using the default profile picture which is in src\resources\images\displayPic. If an valid path to an image is provided, the image will be processed and copied over to the data folder where the addressbook.xml is stored as well.

The image copied over will be stored with a SHA-256 hash name. This hash is calculated over the Person object’s details to ensure a unique filename. The DisplayPic object will store the relative filepath to this new duplicated image. If there is no image or a valid filepath, the DisplayPic object will contain the relative filepath to the default display picture.

Editing a Display Picture

The application will read in the new image to edit and use the filepath of the original image to generate a new unique hash name. This is to prevent the overwriting of image files such as to facilitate the undo command.

Deleting a Display Picture

The current delete uses Java’s deleteOnExit method. It will be updated later on in v1.4 to ensure that files are only deleted when they will definitely not be used.

5.5.2. Design Considerations

Aspect: Filepath to the image

• Alternative 1 (current choice): Copy the image file over to a designated location

  • Pros: The user does not need to maintain the image file, as the application does so itself.

  • Cons: User has to delete the original file if not there will be 2 of the same files on the user’s storage.

• Alternative 2: Use the location of the file the user put in

  • Pros: Potentially less space utilized.

  • Cons: User needs to ensure the file is not moved or deleted.

Aspect: Filename of the image

• Alternative 1 (current choice): Use a hashing algorithm to name the file.

  • Pros: SHA-256 provides collision resistant which means the filename would be unique and it is easy to implement.

  • Cons: It is difficult to manually check which Person the image file belongs to.

• Alternative 2: Use the name of the Person to name the file.

  • Pros: Image files can be easily identified separately and easy to implement.

  • Cons: Could lead to potential image files overwriting each other without additional checks.

5.5.3. Future enhancements

• Support for photo frames and undo for delete (Coming in v1.4)

• Support for frame color to highlight student status (Coming in v1.5)

5.6. Logging

We are using java.util.logging package for logging. The LogsCenter class is used to manage the logging levels and logging destinations.

• The logging level can be controlled using the logLevel setting in the configuration file. (See Section 5.7, “Configuration”)

• The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level.

• Currently log messages are output through: Console and to a .log file.

Logging Levels

• SEVERE : Critical problem detected which may possibly cause the termination of the application

• WARNING : Can continue, but with caution

• INFO : Information showing the noteworthy actions by the App

• FINE : Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size

5.7. Configuration

Certain properties of the application can be controlled (e.g App name, logging level) through the configuration file (default: config.json).

6. Documentation

We use asciidoc for writing documentation.

ℹ️	We chose asciidoc over Markdown because asciidoc, although a bit more complex than Markdown, provides more flexibility in formatting.

6.1. Editing Documentation

See UsingGradle.adoc to learn how to render .adoc files locally to preview the end result of your edits. Alternatively, you can download the AsciiDoc plugin for IntelliJ, which allows you to preview the changes you have made to your .adoc files in real-time.

6.2. Publishing Documentation

See UsingTravis.adoc to learn how to deploy GitHub Pages using Travis.

6.3. Converting Documentation to PDF format

Use Google Chrome for converting documentation to PDF format, as Chrome’s PDF engine preserves hyperlinks used in webpages.

Here are the steps to convert the project documentation files to PDF format.

1. Follow the instructions in UsingGradle.adoc to convert the AsciiDoc files in the docs/ directory to HTML format.

2. Go to your generated HTML files in the build/docs folder, right click on them and select Open with → Google Chrome.

3. Click on the Print option in Chrome’s menu.

4. Set the destination to Save as PDF, then click Save to save a copy of the file in PDF format. For best results, use the settings indicated in the screenshot below.

Figure 12. Saving documentation as PDF files in Chrome

7. Testing

7.1. Running Tests

There are three ways to run tests.

💡	The most reliable way to run tests is the 3rd one. The first two methods might fail some GUI tests due to platform/resolution-specific idiosyncrasies.

Method 1: Using IntelliJ JUnit test runner

• To run all tests, right-click on the src/test/java folder and choose Run 'All Tests'

• To run a subset of tests, you can right-click on a test package, test class, or a test and choose Run 'ABC'

Method 2: Using Gradle

• To run the tests, You need to open a console or terminal and run the command gradlew clean allTests (Mac/Linux: ./gradlew clean allTests)

ℹ️	Detailed information on how to run tests using Gradle is specified in UsingGradle.adoc.

Method 3: Using Gradle (headless)

Thanks to the TestFX library we use, our GUI tests can be run in the headless mode. In the headless mode, GUI tests do not show up on the screen. That means the developer can do other things on the Computer while the tests are running.

To run tests in headless mode, open a console and run the command gradlew clean headless allTests (Mac/Linux: ./gradlew clean headless allTests)

7.2. Types of tests

We have two types of tests:

1. GUI Tests - These are tests involving the GUI. They include,

   1. System Tests that test the entire App by simulating user actions on the GUI. These are in the systemtests package.

   2. Unit Tests that test the individual components. These are in seedu.address.ui package.

2. Non-GUI Tests - These are tests not involving the GUI. They include,

   1. Unit Tests targeting the lowest level methods/classes.
      e.g. seedu.address.commons.StringUtilTest

   2. Integration Tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.address.storage.StorageManagerTest

   3. Hybrids of Unit and Integration Tests. These test are checking multiple code units as well as how the are connected together.
      e.g. seedu.address.logic.LogicManagerTest

7.3. Troubleshooting Testing

Problem: HelpWindowTest fails with a NullPointerException.

• Reason: One of its dependencies, UserGuide.html in src/main/resources/docs is missing.

• Solution: Execute Gradle task processResources.

8. Dev Ops

8.1. Build Automation

See UsingGradle.adoc to learn how to use Gradle for Build Automation.

8.2. Continuous Integration

We use Travis CI and AppVeyor to perform Continuous Integration on our projects. See UsingTravis.adoc and UsingAppVeyor.adoc for more details.

8.3. Coverage Reporting

We use Coveralls to track the code coverage of our projects.
See UsingCoveralls.adoc for more details.

8.4. Documentation Previews

When there are changes to asciidoc files in a pull request, you can use Netlify to see a preview of how the HTML version of those asciidoc files will look like when the pull request is merged.
See UsingNetlify.adoc for more details.

8.5. Making a Release

Here are the steps to create a new release.

1. Update the version number in MainApp.java.

2. Generate a JAR file using Gradle.

3. Tag the repo with the version number. e.g. v0.1

4. Create a new release using GitHub and upload the JAR file you created.

8.6. Managing Dependencies

A project often depends on third-party libraries. For example, Address Book depends on the Jackson library for XML parsing. Managing these dependencies can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives.
a. Include those libraries in the repo (this bloats the repo size)
b. Require developers to download those libraries manually (this creates extra work for developers)

Appendix A: Product Scope

Target user profile: Tech-Savvy University Teachers/Tutors

• have the need to manage a significant number of contacts

• prefer desktop apps over other types

• can type fast

• prefer typing over mouse input

• are reasonably comfortable using CLI apps

Value proposition: manage contacts faster than a typical mouse/GUI driven app, includes to-do list features (with prioritization, etc.) and scheduling (with calendar and reminders)

A.1. Feature contribution

Wu Di

• Major: Implement the todo list

  • Support adding, editing and deleting of tasks

  • Works with undo/redo functions

This enables the tutor to view all tasks in one glance so that he/she is able to stay organized and productive.

• Minor: Import feature to migrate data from an external file

  • Imports data anywhere in any OS

This helps the tutor work on different devices with the unique data set.

• Minor: add the alias feature to some of the commands

  • Support majority of commands

This helps the tutor remember the commands intuitively and type them more efficiently.

Daniel

• Major: Calendar and Scheduler for user

  • Supports adding of new tasks that will be slotted into the calendar(if it has a deadline)

  • Also assigns a priority value to each task based on parameters keyed in when task is added

This helps the tutor to keep track of what needs to be done and which task to focus on.

• Minor: Person has new parameter - Matriculation number

  • Person now stores matriculation number of the person

  • Add command supports adding person with matriculation number(compulsory parameter)

  • Find command supports search by matriculation number

This helps the tutor to easily search for a certain student by their unique matriculation number instead of just their names (e.g. easier than searching for a common name such as Daniel).

Pearlissa

• Major: Login feature

  • Implements new User package

  • [Not confirmed] Encryption of data files containing usernames and passwords

This allows multiple tutors to store their data in separate accounts, which can only be accessed by them.

• Minor: Sorting of contacts based on selected parameters

  • Any number of parameters (at least 1), and in order of priority

This allows tutors to be better able to go through their lists of students.

Ellery

• Major: Display picture for all students entered

  • Support adding, editing and deleting of picture

  • Also works with the redo/undo function

This helps the tutor keep track of his students, and be able to easily remember them better.

• Minor: Email feature to email students

  • Email multiple students quickly

This helps the tutor to quickly bring up an email client to send an email to a student.

Appendix B: User Stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Priority	As a …​	I want to …​	So that I can…​
* * *	new user	see usage instructions	refer to instructions when I forget how to use the App
* * *	new user	get error messages/prompts	better adapt to commands to use them properly
* * *	user	add a new person	better manage all my contacts at one go
* * *	user	delete a person	remove entries that I no longer need
* * *	user	find a person by name	locate details of persons without having to go through the entire list
* * *	user	find a person by matriculation number/email	identify people easily
* * *	user	sort contacts based on name/address/email/tags	work with specific groups of people
* * *	user	assign a to-do list to each person in address book	know what I need to do for them
* * *	user	add individual items to the to-do lists	update additional tasks
* * *	user	remove entire to-do lists or items in it	remove completed tasks
* * *	user	add events to the schedule	better manage work/students
* * *	user	add a deadline to tasks/items	know what needs to be done and by when
* * *	user	prioritize tasks/items	efficiently get tasks/items done on time
* *	user	hide private contact details by default	minimize chance of someone else seeing them by accident
* *	user	import students/people from a text file	it is easier to enter large numbers of people
* *	user	add profile pictures	know who the people I am working with are
* *	user	mass email students/people based on a tag	easily email/inform a class of students of announcements
* *	user	set reminders for certain events	have an email sent to me before the actual event so that I don’t forget
*	user with many persons in the address book	combine groups/tags	better work with people who have similar interests/work

Appendix C: Use Cases

(For all use cases below, the System is the AddressBook and the Actor is the user, unless specified otherwise)

Use case: Delete student

MSS

1. User requests to list students

2. AddressBook shows a list of students

3. User requests to delete a specific student in the list

4. AddressBook deletes the student and all related entries (if any)

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: Find a student by name

MSS

1. User requests to find a student by name

2. AddressBook shows a list of students that match the search query

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

Use case: Add event to schedule

MSS

1. User requests to add an event to a day

2. AddressBook shows the current schedule for the day

3. User requests to add the event to a timeslot for that day

4. AddressBook confirms the addition to the timeslot

   Use case ends.

Extensions

• 2a. The schedule for the day is full.

  • 2a1. AddressBook will display an error message.

    Use case ends.

• 3a. User tries to add it to a non-empty timeslot

  • 3a1. AddressBook will display an error message.

    Use case resumes at step 2.

Use case: Edit lesson for a student

MSS

1. User requests to edit lesson for a student.

2. AddressBook shows the current lessons for a student in a list.

3. User enters the index of lesson to edit.

4. AddressBook prompts the user to enter the new entry.

5. User inputs the new entry.

6. AddressBook confirms with user on the edit.

7. User confirms.

8. AddressBook replaces the old entry with the new entry.

   Use case ends.

Extensions

• 2a. There are no lessons for the student.

  Use case ends.

• 3a. User enters an invalid index

  • 3a1. AddressBook will display an error message.

    Use case resumes at step 3.

• 5a. User does not enter a valid lesson entry

  • 5a1. AddressBook will display an error message.

    User case resumes at step 5.

Appendix D: Non Functional Requirements

1. Should work on any mainstream OS as long as it has Java 1.8.0_60 or higher installed.

2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.

3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.

4. Should be intuitive or easily understood after reading the User Guide.

5. Should not exceed the size of 100 MB.

6. Should respond to any requests within 3 seconds.

7. Should not modify and copy any user’s personal data on the computer.

8. A User’s data should be password protected.

Appendix E: Glossary

Mainstream OS

Windows, Linux, Unix, OS-X

Private contact detail

A contact detail that is not meant to be shared with others

User interface

The visible interface that the user will be seeing when using the application

Logic

The set of commands that can be executed by the application

Model

The internal memory used when application is running

Storage

The set of instructions to store specific states and data of the application when application is not running so that it can be loaded back into the application when application is started again.

Feature

A specific function of the program

Parser

A converting function or class that takes in raw input and separates it into its usable components for other methods

Tasks

A command to be executed

Deadline

The date for which certain tasks are due to be done

SHA-256

A cryptographic hash that is akin to a 'signature' for a text or a data file. SHA-256 generates an almost-unique 256-bit (32-byte) signature for a text.

Tags

Keywords tied to categories or people

To-do list

A list of things to do

Import

Bring into the application from an external source

Appendix F: Product Survey

Product Name

Author: …​

Pros:

• …​

• …​

Cons:

• …​

• …​

Appendix G: Instructions for Manual Testing

Given below are instructions to test the app manually.

ℹ️	These instructions only provide a starting point for testers to work on; testers are expected to do more exploratory testing.

G.1. Launch and Shutdown

1. Initial launch

   1. Download the jar file and copy into an empty folder

   2. Double-click the jar file
      Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

2. Saving window preferences

   1. Resize the window to an optimum size. Move the window to a different location. Close the window.

   2. Re-launch the app by double-clicking the jar file.
      Expected: The most recent window size and location is retained.

{ more test cases …​ }

G.2. Deleting a person

1. Deleting a person while all persons are listed

   1. Prerequisites: List all persons using the list command. Multiple persons in the list.

   2. Test case: delete 1
      Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

   3. Test case: delete 0
      Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

   4. Other incorrect delete commands to try: delete, delete x (where x is larger than the list size) {give more}
      Expected: Similar to previous.

{ more test cases …​ }

G.3. Saving data

1. Dealing with missing/corrupted data files

   1. {explain how to simulate a missing/corrupted file and the expected behavior}

{ more test cases …​ }