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

Update ppp (I hope this will be the last time) #354

Merged
merged 3 commits into from
Nov 13, 2023
Merged

Update ppp (I hope this will be the last time) #354

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d54d01c
Update PPP
ziyi105 Nov 13, 2023
77e1c72
Merge branch 'general-coding-standard-check'
ziyi105 Nov 13, 2023
5c1113c
Add reviews on other teams' PR
ziyi105 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
13 changes: 7 additions & 6 deletions docs/team/ziyi105.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ Café proprietors who prefer typing on CLI than any other interaction method and
Extra info: This feature requires constant updating whenever a new feature is added. It is also very tedious to implement Junit test as the output is very long and keeps changing. Hence, I removed the Junit test in the last iteration as I feel that it is not necessary to have Junit test for a trivial `help` command.
<br/><br/>
3. **Encoding & Decoding of Pantry Stock Storage File** <br>
Function: When the user calls bye command, all the ingredients stored in pantry will be encoded into format of `INGREDIENT_NAME | QUANTITY | UNIT`. The encoded data will be written in Pantry_stock.txt file. When the user starts a new session, the data in the text file will be extracted out and be decoded to load the ingredients back to PantryStock class.<br>
Function: When the user calls bye command, all the ingredients stored in pantry will be encoded into format of `INGREDIENT_NAME | QUANTITY | UNIT`. The encoded data will be written in pantry_stock.txt file. When the user starts a new session, the data in the text file will be extracted out and be decoded to load the ingredients back to PantryStock class.<br>
Error Handling: This command will still check for the validity of each argument (e.g., length of ingredient name, type of unit), and skip the particular ingredient if any of the arguments is not valid. This can prevent the user from accidentally adding invalid ingredients to the text file.

### Enhancements
1. **Storage**<br>
[Relevant PR](https://github.com/AY2324S1-CS2113-T17-2/tp/pull/143) <br>
- Read and learned from the storage system in addressbook level 3 and adopted it in our project.
- Implemented `Encoding.java`, `Decoding.java` and `Storage.java` with skeleton methods for my teammates to implement.
- Implemented `Encoder.java`, `Decoder.java` and `Storage.java` with skeleton methods for my teammates to implement.
<br><br>
2. **Parser**<br>
Created `Parser.java` for other teammates to use. Implemented ParserUtil interface to reduce coupling of Parser.java and CafeCRTL.java.
Expand Down Expand Up @@ -87,13 +87,14 @@ Café proprietors who prefer typing on CLI than any other interaction method and
6. Glossary
7. General formatting
- Ensure consistency of features descriptions and diagrams
- Correct typos and grammar error
- Correct typos and grammar errors

### Other Contributions to Team-based Task
1. Maintaining issue tracker with Dexter by labeling issues
2. Adding theme to UG & DG
3. Approving and merging PRs
4. Reminding team members to use github effectively (although some of my reminders were ignored :")
4. Checking coding standard for most of the classes ([PR #351](https://github.com/AY2324S1-CS2113-T17-2/tp/pull/351))
5. Reminding team members to use github effectively (although some of my reminders were ignored :")
- I encouraged my team members to report bugs using issue tracker on Github instead of using Telegram. (e.g., [#323](https://github.com/AY2324S1-CS2113-T17-2/tp/issues/323))
- I requested PR reviews from my team members as I noticed they haven't had a chance to do any review. (e.g., [PR #51](https://github.com/AY2324S1-CS2113-T17-2/tp/pull/51))

Expand All @@ -111,6 +112,6 @@ Café proprietors who prefer typing on CLI than any other interaction method and
![Relevant Telegram screenshot 4](../images_PPP/ziyi/relevant_telagram_screenshot_4.png)

### Contributions beyond the Project Team
1. Posted 8 posts in the forum.
1. Posted 9 posts in the forum.
Examples of forum posts: [#37](https://github.com/nus-cs2113-AY2324S1/forum/issues/37), [#19](https://github.com/nus-cs2113-AY2324S1/forum/issues/19), [#31](https://github.com/nus-cs2113-AY2324S1/forum/issues/31)
2. Reviews on PR from other teams: [T18-1](https://github.com/nus-cs2113-AY2324S1/tp/pull/19#discussion_r1379823357)
2. Reviews on PR from other teams: [T18-1](https://github.com/nus-cs2113-AY2324S1/tp/pull/19#discussion_r1379823357), [F11-3](https://github.com/nus-cs2113-AY2324S1/tp/pull/28)
Loading