Skip to content

Commit

Permalink
Merge pull request #281 from samuelim01/update-ppp-reformat
Browse files Browse the repository at this point in the history
Reformat PPP (Samuel)
  • Loading branch information
samuelim01 authored Nov 13, 2023
2 parents c07e631 + 22d80bf commit 9254e03
Showing 1 changed file with 42 additions and 28 deletions.
70 changes: 42 additions & 28 deletions docs/team/samuelim01.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,61 @@
title: "Samuel Lim's Project Portfolio Page"
---

### Project: WedLog
## Project: WedLog

WedLog is a desktop application created for partners getting married that helps them manage the guests and vendors involved in the wedding. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. This project is based on [AddressBook - Level 3](https://se-education.org/addressbook-level3/).

Given below are my contributions to the project.

### Features

1. **New Feature**: Modified some fields to be optional for guests and vendors.
* What it does: allows the user to leave optional fields empty for guests and vendors.
* Justification: This feature improves the product significantly because a user may not want to specify all the fields of a guest or vendor, and the app should provide the flexibility for the user to do so.
* Credits: Partially adapted from [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).
* What it does: allows the user to leave optional fields empty for guests and vendors.
* Justification: This feature improves the product significantly because a user may not want to specify all the fields of a guest or vendor, and the app should provide the flexibility for the user to do so.
* Credits: Partially adapted from [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).

2. **New Feature**: Added the ability to edit vendors.
* What it does: allows the user to edit fields of a vendor.
* Justification: This feature improves the product significantly because a user may want to modify vendor information and the app should provide an easy way to do so without having to remove and add back the vendor.
* Highlights: The implementation was challenging because vendors have optional fields which can be removed by using empty prefixes in the edit command. This required a careful consideration of design alternatives.
* What it does: allows the user to edit fields of a vendor.
* Justification: This feature improves the product significantly because a user may want to modify vendor information and the app should provide an easy way to do so without having to remove and add back the vendor.
* Highlights: The implementation was challenging because vendors have optional fields which can be removed by using empty prefixes in the edit command. This required a careful consideration of design alternatives.

3. **New Feature**: Added the ability to undo/redo previous commands.
* What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
* Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
* Credits: Adapted from [AddressBook Level-4](https://github.com/se-edu/addressbook-level4).
* What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
* Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
* Credits: Adapted from [AddressBook Level-4](https://github.com/se-edu/addressbook-level4).

<br>

### Code Contributed

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

<div style="page-break-after: always;"></div>

### Code Contributed
[RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=samuelim01&breakdown=true)
### Project Management

* Renamed `seedu` package to `wedlog` : [\#96](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/96)
* Deleted dead code: [\#236](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/236/), [\#237](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/237/), [\#247](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/247/), [\#260](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/260/)
* Managed releases `v1.1` - `v1.1.1` (2 releases: [1](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/tag/v1.1), [2](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/tag/v1.1.1)) on GitHub

<br>

### Documentation
* User Guide:
* Added documentation for the features `vendor add` and `vendor delete`: [\#40](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/40/)
* Added documentation for the features `undo` and `redo`: [\#121](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/121)
* Added documentation for the feature `vendor edit`: [\#128](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/128)
* Added cosmetic tweaks to the structure: [\#154](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/154), [\#162](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/162)
* Developer Guide:
* Added non-functional requirements: [\#39](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/39)
* Updated Logic, Model, Storage component sections: [\#112](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/112)
* Added implementation details for the feature `edit`: [\#149](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/149)
* Updated Appendix B: [\#262](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/262)

### Contributions to team tasks
* Renamed `seedu` package to `wedlog` : [\#96](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/96)
* Managed releases `v1.1` - `v1.1.1` (2 releases: [1](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/tag/v1.1), [2](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/tag/v1.1.1)) on GitHub

* User Guide:
* Added documentation for the features `vendor add` and `vendor delete`: [\#40](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/40/)
* Added documentation for the features `undo` and `redo`: [\#121](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/121)
* Added documentation for the feature `vendor edit`: [\#128](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/128)
* Added cosmetic tweaks to the structure: [\#154](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/154), [\#162](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/162)
* Developer Guide:
* Added non-functional requirements: [\#39](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/39)
* Updated Logic, Model, Storage component sections: [\#112](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/112)
* Added implementation details for the feature `edit`: [\#149](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/149)
* Updated Appendix B: [\#262](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/262)

<br>

### Community
* PRs reviewed (with non-trivial review comments): [\#116](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/116), [\#127](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/127), [\#129](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/129)
* Reported [bugs and suggestions](https://github.com/samuelim01/ped/issues) for other teams

* PRs reviewed (with non-trivial review comments): [\#116](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/116), [\#127](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/127), [\#129](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/129)
* Reported [bugs and suggestions](https://github.com/samuelim01/ped/issues) for other teams

0 comments on commit 9254e03

Please sign in to comment.