Skip to content

Commit

Permalink
Merge pull request AY2324S1-CS2113-T18-4#185 from lckjosh/master
Browse files Browse the repository at this point in the history
Update UG FAQ and PPP
  • Loading branch information
lckjosh authored Nov 13, 2023
2 parents 1cdcbec + c2bbc9e commit c48cf61
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 6 deletions.
9 changes: 4 additions & 5 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,15 +345,14 @@ Thank you for using NUScents. Hope to see you again soon!

**Q**: How do I transfer my data to another computer?

**A**: There are 2 files used for storage, `./data/nuscents.txt` and `./data/hmac`. Copy both files over to the target
**A**: There are 2 files used for storage, `./data/nuscents.txt` and `./data/budget.txt`. Copy both files over to the target
computer.

**Q**: What happens if I modify the storage file ?

**A**: The application is programmed to exit immediately if it detects that the storage file has been tampered with.
You will either need to revert the storage file back to the last known 'good state', or delete both the
`./data/nuscents.txt` and `./data/hmac` files and run the program again. Note that deleting the files will cause a loss
of previously stored data.
**A**: The application is programmed to handle modification of the storage file, however, no support is guaranteed if
you choose to do so. Unexpected behaviour will occur if you modify the storage file in an unsupported way. If a particular
transaction entry is corrupted, the program will try to skip it and read the next transaction entry.

## Command Summary 💡

Expand Down
29 changes: 28 additions & 1 deletion docs/team/lckjosh.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,31 @@ View my code contributions here: [Reposense](https://nus-cs2113-ay2324s1.github.

### Enhancements implemented
- Feature: Added the ability to add expenses
- Creation of Transaction, Expense classes
- Created methods in Parser to validate user input for adding expenses
- Created methods in Storage to load expenses from data file
- Created TransactionList to store and manipulate transactions
- Feature: Added the ability to add allowances
- Creation of Transaction, Allowance classes
- Created methods in Parser to validate user input for adding allowances
- Created methods in Storage to load allowances from data file
- Created TransactionList to store and manipulate transactions
- Feature: Added the ability to categorise allowances
- Bugfix: Allow modification of storage file and handle improper file input
- Created AllowanceCategory
- Modified Parser to parse valid allowance categories
- Modified Ui to print allowance category in relevant outputs
- Bugfix: Log to file instead of console: [#44](https://github.com/AY2324S1-CS2113-T18-4/tp/issues/44)
- Bugfix: Allow modification of storage file and handle improper file input.
Github issues:
[#63](https://github.com/AY2324S1-CS2113-T18-4/tp/issues/63),[#92](https://github.com/AY2324S1-CS2113-T18-4/tp/issues/92),
[#99](https://github.com/AY2324S1-CS2113-T18-4/tp/issues/99),[#104](https://github.com/AY2324S1-CS2113-T18-4/tp/issues/104)
- Explored using HMAC to verify integrity of storage file [#64](https://github.com/AY2324S1-CS2113-T18-4/tp/pull/64)
- Eventually removed to align with tP constraints of human-editable file

### Contributions to the UG
- Created the format for commands in the Features section
- Ideated the example outputs given
- FAQ

### Contributions to the DG
- Acknowledgements
Expand All @@ -30,4 +48,13 @@ View my code contributions here: [Reposense](https://nus-cs2113-ay2324s1.github.
- Storage Component
- Implementation: `list` Transactions Feature

### Contributions to team-based tasks
- Set up the team repository
- Heavily refactored code from original [Spaceman Task Manager](https://github.com/spaceman03/ip/)
in the initial phase of the project (when developing the basic adding allowance/expense feature)
- Reviewed non-trivial PRs [#24](https://github.com/AY2324S1-CS2113-T18-4/tp/pull/24), [#74](https://github.com/AY2324S1-CS2113-T18-4/tp/pull/74)
- Assisted team members with help if needed (e.g. edit command feature syntax and implementation)
- Developed JUnit tests for the methods used in Parser when adding transactions

### Contributions beyond the project team
Reported 7 bugs in the PE-D on [GitHub](https://github.com/lckjosh/ped/issues)

0 comments on commit c48cf61

Please sign in to comment.