Skip to content

Commit

Permalink
Merge pull request #80 from putaojuice/documentation-v1.3
Browse files Browse the repository at this point in the history
Documentation v1.3
  • Loading branch information
putaojuice authored Mar 31, 2022
2 parents 5ed5b16 + c5affc7 commit 8909d4c
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 22 deletions.
15 changes: 1 addition & 14 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,12 @@ If you can type fast, NUScheduler can schedule your tasks faster than traditiona
- Add task
- Delete task
- Update task
- Add a label to a task
- View all tasks and their deadlines
- Contact Management
- Add contact
- Delete contact
- Update contact
- View all contacts
- Reminder
- Remind the user of upcoming tasks
- Exit the app
- FAQ
- CLI Summary
Expand Down Expand Up @@ -102,14 +99,6 @@ Format: `upd t t <integer> /DEADLINE`

Example: `upd t t <integer> /2022 03 10 12pm`

### Feature - Label a task: `lab t <integer>`

Label a task based on a specific tag, where `<integer>` is the ID of the task.

Format: `label t <integer> tag`

Example: `label t 3 important`

### Feature - Find tasks: `findt KEYWORD`

Locating tasks which match any of given keywords.
Expand Down Expand Up @@ -217,11 +206,9 @@ data of your previous NUScheduler home folder.
| **upd t d <integer>** | `upd t d <integer>  /DESCRIPTION`<br> e.g., `upd t d 3 /Buy groceries` |
| **upd t t <integer>** | `upd t t <integer> /DEADLINE`<br> e.g.,`upd t t <integer> /2022 03 10 12pm` |
| **findt KEYWORD** | `findt <KEYWORD>` <br> e.g., `findt lessons` |
| **lab t <integer>** | `label t <integer> tag` <br> e.g., `label t 3 important` |
| **view t** | `view t` |
| **viewt** | `view t` |
| **add c** | `add c /NAME /EMAIL /TELEGRAM [/TAG]` <br> e.g., `add c /Betsy Crow /[email protected] /betsyc /Group Member` |
| **del c <integer>** | `del c <integer>` <br> e.g., `del c 3` |
| **upd c <integer>** | `upd c /NAME /EMAIL /TELEGRAM [/TAG] <integer>` <br> e.g., `upd c /John Doe  /[email protected] /johntele 23` |
| **view c** | `view c [to] [t] [/TAG]` <br> e.g., `view c` |
| **remind** | `remind [<integer>]` <br> e.g., `remind 10` |
| **exit** | `exit` |
41 changes: 33 additions & 8 deletions docs/team/putaojuice.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ If you can type fast, NUScheduler can schedule your tasks faster than traditiona

Given below are my contributions to the project.

* **New Feature**: Implemented `AddTask` command.
* **New Feature**: Implemented `AddTask` command ([#26](https://github.com/AY2122S2-CS2103-F11-4/tp/pull/26)).
* What it does: Allow the user to add a task to the application with description and deadline (optional)
* Justification: Our target audience is year 1 computing students. It helps them to keep track of their assignments
and any other daily tasks.
and any other daily tasks.
* **Classes created**:
* `AddTaskCommand`
* `AddTaskCommandParser`
Expand All @@ -24,12 +24,35 @@ Given below are my contributions to the project.
* `Task` and `TaskList` classes are created to capture the information of tasks and store them as an `ArrayList` in
`ModelManager`.

* **Code contributed**: [RepoSense link (to be added soon)]()
* **New Feature**: Implemented `TaskListStorage` ([#74](https://github.com/AY2122S2-CS2103-F11-4/tp/pull/74)).
* What it does: The system will write the task list to user's local folder in Json format whenever there is a change
in the task list. The system will read from the saved task list from user's local folder in Json format when starting up
to load the stored task list from the last access.
* Justification: This feature allows the user to save their task list and continue where it was left from.
* **Classes created**:
* `ReadOnlyTaskList`
* `JsonAdaptedTask`
* `JsonSerializableTaskList`
* `JsonTaskListStorage`
* `TaskListStorage`
* **Tests written**:
* `JsonAdaptedTaskTest`
* `JsonSerializableTaskListTest`
* `JsonTaskListStorageTest`
* `TypicalTask`
* **Additional info**:
* This feature requires a good understand of how the application is designed and involves modification to
`Logic`, `Model` and `Storage`

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=putaojuice&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2022-02-18&tabOpen=true&tabType=authorship&tabAuthor=putaojuice&tabRepo=AY2122S2-CS2103-F11-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false)

* **Project management**:
* Managed release `v1.1`, `v1.2`.
* Managed release `v1.1`, `v1.2`, `v1.3`.
* Organised weekly project meeting and set up weekly milestone.
* Reviewed pull requests.
* Wrap up every milestone.
* Released `Trial v1.3` ([#61](https://github.com/AY2122S2-CS2103-F11-4/tp/pull/61)).
* Complete any administrative matters for the team.

* **Enhancements to existing features**:
* to be added soon
Expand All @@ -41,11 +64,13 @@ Given below are my contributions to the project.
* Added various non-functional requirement in the developer guide.
* Contribute to glossary in the developer guide.
* Added MSS for `AddTask`.
* Added information about the implementation of the `AddTask` command ([#60](https://github.com/AY2122S2-CS2103-F11-4/tp/pull/60))
* Added 2 UML diagrams to aid the explanations

* **Community**:
* to be added soon
* Participate in forum ([#240](https://github.com/nus-cs2103-AY2122S2/forum/issues/240))

* **Tools**:
* to be added soon


* Set up the team's Github group and repo.
* Added CodeCov integration to the repo.
* Enabled assertions for the project ([#61](https://github.com/AY2122S2-CS2103-F11-4/tp/pull/61)).

0 comments on commit 8909d4c

Please sign in to comment.