Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Reformat Megan PPP #176

Merged
merged 5 commits into from
Nov 14, 2023
Merged

docs: Reformat Megan PPP #176

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b5fc828
docs: Shorten desc
m1oojv Nov 13, 2023
dc19a46
docs: Update UG DG
m1oojv Nov 13, 2023
f775b8b
docs: Remove break
m1oojv Nov 13, 2023
fd2c749
docs: Shorten PPP
m1oojv Nov 13, 2023
bb9112f
docs: Add explaination
m1oojv Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions docs/team/m1oojv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,30 @@ CoordiMate is a **desktop application** designed specifically for **SoC Computin
Given below are my contributions to the project.

* **New Feature**: `editPerson` (PR [#76](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/76))
* What it does: Allows users to modify existing person records, updating contact details as needed.
* Justification: Enhances flexibility and accuracy in managing contacts, ensuring up-to-date information.
* What it does: Allows users to modify existing person records.
* Justification: Able to update contacts, ensuring up-to-date information.
* Credits: The `editPerson` command was adapted from the `edit` command in the AddressBook-Level3 project (AB3) created by the [SE-EDU initiative](https://se-education.org).<br><br>

* **New Feature**: `deleteAllTask` (PR [#90](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/90))
* What it does: Enables users to delete all tasks at once, cleaning up to a fresh new start of the task list.
* Justification: Provides a quick solution for clearing tasks, enhancing organization and decluttering the interface.
* Highlights: This feature required me to have an in-depth understanding of the execution pipeline for commands and making the right design decisions when creating and manipulating a task list based on existing `UniquePersonList`.
* What it does: Enables users to delete all tasks and start with a new task list.
* Justification: Provides a quick way to clear all tasks, decluttering the interface.
* Highlights: This feature required me to have an in-depth understanding of the execution pipeline for commands when manipulating a task list based on existing `UniquePersonList`.
* Credits: The `deleteAllTask` command was inspired by the `clear` command in AB3.<br><br>

* **New Feature**: `markTask` & `unmarkTask` (PR [#86](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/86))
* What it does: Allows users to mark tasks as completed or undo task completion status, indicating progress and keeping track of accomplished tasks.
* Justification: Easy task status update, ensuring users stay on top of their to-do list, aiding in progress assessment and prioritization.
* Highlights: This feature involved creating a new `Status` field and `TaskStatus` enumeration, ensuring a clear distinction between completed (`DONE`) and pending (`NOT_DONE`) tasks. Utilizing `STATUS_DONE` and `STATUS_NOT_DONE` constants further enhanced readability and differentiation of task states within the `Status` class. <br><br>
* What it does: Allows users to mark tasks as completed or not completed, keeping track of task progress.
* Justification: Ensuring users stay on top of their to-do list, aiding in prioritization.
* Highlights: This feature involved creating a new `Status` field and `TaskStatus` enumeration. Utilizing `STATUS_DONE` and `STATUS_NOT_DONE` constants further enhanced consistency within the codebase. <br><br>

* **New Feature**: `findDone` & `findNotDone` (PR [#99](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/99))
* What it does: Facilitates quick search and display of all completed or pending tasks, aiding in review and prioritization.
* Justification: Instant retrieval of completed or pending tasks, promoting effective task analysis.
* Highlights: Implementing this feature required an in-depth understanding of how lists are displayed in JavaFX. New predicates were implemented based on the existing `PREDICATE_SHOW_ALL_PERSONS` in AB3. <br><br>
* What it does: Facilitates quick search and display of all completed or pending tasks.
* Justification: Aiding users in task prioritization and effective task analysis.
* Highlights: This feature required to know how lists are displayed in JavaFX. New predicates were created based on existing `PREDICATE_SHOW_ALL_PERSONS` in AB3. <br><br>

* **New Feature**: `deleteAllDone` (PR [#115](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/115))
* What it does: Provides the option to delete all completed tasks, keeping the task list concise and relevant.
* Justification: Reduces clutter, ensuring users focus on ongoing and upcoming tasks without distractions.
* Highlights: Implementing this feature required an in-depth understanding of how dynamic nature of the list and the necessity to maintain order, the loop approach was adjusted.
The loop iteration from the back was found to be essential for proper deletion, overcoming index errors and ensuring the accurate removal of completed tasks.<br><br>
* What it does: Provides the option to delete all completed tasks.
* Justification: Reduces clutter, ensuring users focus on upcoming tasks.
* Highlights: This feature required an understanding on the dynamic nature of list. The loop iteration from the back was found to be essential for proper deletion, ensuring the accurate removal of completed tasks.<br><br>

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=m1oojv&breakdown=true)

Expand All @@ -50,15 +49,17 @@ The loop iteration from the back was found to be essential for proper deletion,
* User Guide:
* Add documentation for the `editPerson`, `deleteAllTask`, `markTask`, `unmarkTask`, `findDone`, `findNotDone` and `deleteAllDone` commands.
* Add list of features of CoordiMate (PR [#108](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/108))
* Add Glossary (PR [#160](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/160))
* Add self drawn mockups of GUI for User Guide (Commit [#0a25954](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/20/commits/0a25954d0d7a5b4d0a5b5da7ddf313bd0861c78b))
* Developer Guide:
* Add user stories and use cases for `editPerson`, `deleteAllTask`, `markTask`, `unmarkTask`, `findDone`, `findNotDone` and `deleteAllDone` commands.
* Added implementation details and design considerations of `markTask` feature (PR [#100](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/100))<br><br>
* Add implementation details and design considerations of `markTask` feature with sequence diagram and activity diagram (PR [#100](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/100))
* Add Planned enhancements (PR [#163](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/163)) <br><br>

* **Community**:
* PRs reviewed (with non-trivial review comments): PR [#56](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/56), [#91](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/91), [#89](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/89), [#88](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/88), [#84](https://github.com/AY2324S1-CS2103T-T10-2/tp/pull/84)
* Contributed to forum discussions: Forum [#6](https://github.com/nus-cs2103-AY2324S1/forum/issues/6)
* Reported 5 bugs and suggestions during PE Dry Run. ([Repo](https://github.com/m1oojv/ped/issues))<br><br>

* **Tools**:
* Created mockup templates for teammates to use when adding mockups to the UG ([link](https://docs.google.com/presentation/d/1fXBqhAU6SSoSZdYVog3G9v5H6gXFMCzPAQ2BjzzWzM4/edit#slide=id.p))<br><br>
* Created mockup templates for teammates to use when adding mockups to the UG ([link](https://docs.google.com/presentation/d/1fXBqhAU6SSoSZdYVog3G9v5H6gXFMCzPAQ2BjzzWzM4/edit#slide=id.p))
Loading