Skip to content

Commit

Permalink
Merge pull request #198 from wlren/branch-ppp-dg
Browse files Browse the repository at this point in the history 
Update PPP
  • Loading branch information
@yeppog
yeppog authored Nov 8, 2021
2 parents b2955d1 + 2c31fa1 commit 4ccabeb
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 35 deletions.
70 changes: 37 additions & 33 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ layout: page
title: Developer Guide
---

- Table of Contents
{:toc}
## Table of Contents
1. [Design](#design)
2. [Implementation](#imple)
3. [Guides and Documentation](#guides)
4. [Appendix](#appen)
1. [Requirements](#requirements)
2. [Manual Testing](#test)

---

## **Acknowledgements**

- {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
- PlantUML was used for the UML diagrams in this project.
- This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
---

## **Setting up, getting started**
Expand All @@ -20,6 +24,8 @@ Refer to the guide [_Setting up and getting started_](SettingUp.md).

---

<a name="design"></a>

## **Design**

<div markdown="span" class="alert alert-primary">
Expand Down Expand Up @@ -154,6 +160,8 @@ Classes used by multiple components are in the `seedu.addressbook.commons` packa

---

<a name="imple"></a>

## **Implementation**

This section describes some noteworthy details on how certain features are implemented.
Expand Down Expand Up @@ -484,12 +492,10 @@ Each of the following expressions return a `TaskFilter`:

1. Task filters could be implemented using a `FunctionalInterface` having a `boolean filter(Task task)` method. However, this does not allow a task filter to contain extra information like having a custom string representation.

### \[Proposed\] Data archiving

_{Explain here how the data archiving feature will be implemented}_

---

<a name="guides"></a>

## **Documentation, logging, testing, configuration, dev-ops**

- [Documentation guide](Documentation.md)
Expand All @@ -500,6 +506,9 @@ _{Explain here how the data archiving feature will be implemented}_

---

<a name="appen"></a>

<a name="requirements"></a>
## **Appendix: Requirements**

### Product scope
Expand All @@ -522,28 +531,23 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

| Priority | As a …​ | I want to …​ | So that I can…​ |
| -------- | ---------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------- |
| `* * *` | student | add tasks into a tasklist | keep a list of tasks I need to do |
| `* * *` | student | add tasks into a task list | keep a list of tasks I need to do |
| `* * *` | student | delete tasks | remove tasks that are no longer applicable |
| `* * *` | student with one laptop | access my data locally | use the application without an internet connection |
| `* * *` | new user | use the GUI | use the app easily from the desktop |
| `* * *` | student | see the task list as a GUI | easily visualize the tasks I have |
| `* * *` | student who often makes typos | edit tasks | correct tasks that were entered wrongly |
| `* * *` | student with similar tasks | create skeleton templates | add tasks without repeating actions |
| `* * *` | student with different commitments | categorise tasks using tags | differentiate whcih tasks belongs to which commitment |
| `* * *` | student with different commitments | overview of my tasks by workload | understand which tasks I need to prioritise |
| `* * *` | student who is forgetful | receive reminders | be reminded for upcoming tasks |
| `* * *` | student who receives periodic assignments | create recurring tasks that repeat at a set interval | save time |
| `* *` | student with varying type of tasks | attach various files or messages | increase convenience of access |
| `* *` | a veteran user | have CLI to organise my tasks | save time from not having to point and click on the GUI |
| `* *` | busy student | be able to add tasks using CLI | save time from not needing to sort my schedule |
| `* *` | student that manages multiple projects across different modules | tag tasks with contacts | know who is participating in which meeting or task |
| `* *` | a student who love data and visualisations | view previously completed tasks over time | gain insights into my producitvity |
| `*` | student with similar tasks | create custom macros | save time |
| `*` | student that is finishing their semester | purge data on tasks and templates | remove clutter on my app |
| `*` | student with many tasks | track progress for tasks | visualise the time required for each task |
| `*` | student who has to manage projects with peers | create tasks that can be emailed to individuals on my contact list | facilitate quick communication |
| `*` | student who easily gets bored focusing too much on a single task | shuffle the arrangement of upcoming tasks | work on another task with similar priority |
| `* * *` | student with different commitments | categorise tasks using tags | differentiate which tasks belongs to which commitment |
| `* * *` | student | mark a task as complete | know that a task is complete and move on to other tasks |
| `* * *` | student | search for tasks using keywords in title and description | look for specific or relevant tasks in the list |
| `* * *` | student | filter the task list displayed by their tags | look for specific categories of tasks |
| `* *` | student that manages tasks involving people | tag tasks with contacts | know who is participating in which meeting or task |
| `* *` | student | add description to a task | add further information about the task |
| `* *` | student | add timestamps to a task | keep track of deadlines of individual tasks |
| `* *` | student | filter the task list displayed by their completion status | view only tasks that are done/undone |
| `* *` | student | use arrow up and down keys to view previous commands that were executed | quickly repeat similar commands |
| `*` | student that is finishing a certain type of tasks | purge data on tasks based on filters | remove clutter on my app |
| `*` | student who is loses track of deadlines | see which tasks are overdue | to be reminded of what tasks I urgently need to do |
| `*` | student who may make mistakes | undo my changes | revert any changes if needed |
| `*` | student who has some tasks of utmost importance | designate special tasks that block out a certain time period | avoid scheduling other tasks that clash with them |

### Use cases

Expand Down Expand Up @@ -879,7 +883,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
- **Tags**: User-defined label attached a task to provide identification and/or information

---

<a name="test"></a>
## **Appendix: Instructions for manual testing**

Given below are instructions to test the app manually.
Expand All @@ -895,16 +899,15 @@ testers are expected to do more *exploratory* testing.

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

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

1. Saving window preferences

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

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

1. _{ more test cases …​ }_


### Deleting a person

Expand All @@ -921,12 +924,13 @@ testers are expected to do more *exploratory* testing.
1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)<br>
Expected: Similar to previous.

1. _{ more test cases …​ }_

### Saving data

1. Dealing with missing/corrupted data files

1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_
1. To simulate missing file, you can delete any files in the '`ata` folder.<br>
Expected: Re-starting the application would result in the default set of sample contacts and/or tasks depending on which file(s) was deleted.
2. To simulate corrupted data file, you can alter data entries of any files in the `data` folder.<br>
Expected: Re-starting the application would result in either loading in the altered `data` file if the alteration fits the definitions of a `task` and `contact`, or it would result in the data file being deleted and restarting from the sample set of data if the definitions were not followed.

1. _{ more test cases …​ }_
23 changes: 22 additions & 1 deletion docs/team/wlren.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,30 @@ It adds extensive task-tracking functionalities to the base application, and has
Given below are my contributions to the project.

- **New Feature**: Added time stamp validation to tasks
- **Enhancement to existing features**:
- What it does: Add date semantics to the ts/ field for tasks, only taking in dd-MM-YYYY format input.
- Justifications: This allows the internal `Timestamp` field for `Task` to be stored as utilizing `LocalDate` instead of a simple string message. And helps assures that users
are only able to key in a proper date in the ts/ field to adhere to its purpose.
- Highlights: This change allows for new features to be developed, such as highlighting tasks which are overdue (implemented), and filtering tasks by a certain date range or sorting by date (not implemented).
- **Enhancement to existing features**: Update `Storage` features to accommodate for task list
- What it does: Create a separate storage path for task list related storage under `/data/tasklist.json`.
- Justifications: A similar JSON convertible architecture was used from `addressbook.json` for `tasklist.json`, the conversion was more flexible as the tasks had many optional fields unlike the addressbook.
- Highlights: Having two separate lines of storage for two different parts of the TaskMaster2103 helps compartmentalize storage and makes sure that the reading and writing of data after an operation is more efficient as only the part that experiences changes would need to invoke the storage process.
- **Testing**:
- Updated Task testcases after Date semantics [#89](https://github.com/AY2122S1-CS2103-F09-2/tp/pull/89)
- Add Storage related testcases for tasks [#199](https://github.com/AY2122S1-CS2103-F09-2/tp/pull/199)
- **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&tabOpen=true&tabType=authorship&tabAuthor=wlren&tabRepo=AY2122S1-CS2103-F09-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false)
- **Documentation**:
- Developer Guide:
- Added User Stories, Project Scope.
- Updated Storage related documentation.
- User Guide:
- Updated Command Summary.
- Overall formatting and structure.
- **Project management**:
- Managed issues and bug triaging.
- Managed Github JAR releases and other project submissions.
- **Community**:
- Set up team meetings and facilitate discussions.
- Allocated work and act as team lead.
- PRs reviewed: [#43](https://github.com/AY2122S1-CS2103-F09-2/tp/pull/43), [#74](https://github.com/AY2122S1-CS2103-F09-2/tp/pull/74)

2 changes: 1 addition & 1 deletion docs/team/yeppog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Below are my contributions to the project.
The feature also keeps track of whatever one has currently typed. Pressing up or down after typing something that
has not been executed stores the typed command down, and can be accessed simply by pressing down to the very last
command.

- **Code contributed**: [Reposense link](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&tabOpen=true&tabType=authorship&tabAuthor=yeppog&tabRepo=AY2122S1-CS2103-F09-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false)

- **Enhancements to existing features**: Improved the preliminary design of the help window.
Expand Down

0 comments on commit 4ccabeb

Please sign in to comment.