Skip to content

Commit

Permalink
Merge pull request #223 from sp4ce-cowboy/UniCash-1.4/DGFinal
Browse files Browse the repository at this point in the history
[Documentation] DG Final Updates
  • Loading branch information
jamz903 authored Nov 14, 2023
2 parents bad9f9d + 782a191 commit 09c84dd
Showing 1 changed file with 45 additions and 4 deletions.
49 changes: 45 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1826,16 +1826,51 @@ Expected: UniCa$h closes.
### Appendix: Planned Enhancements
**Get_Budget Command**
- The current `get_budget` command does not alter the transaction list when processing the expenses within the interval. This can lead to confusion as users may not be aware of the specific transactions that are being included in the calculation of the budget remainder, and as a result, mistaking the budget calculation as not working.
We plan to apply a filter to the transaction list, like in `get_total_expenditure`, when `get_budget` is run to accurately display the list of transactions that we have included for the calculation to reduce this potential user confusion.
- The current `get_budget`'s weekly interval calculation uses the week of year. However, given that this information is not immediately intuitive to users, users may not be aware of how weekly budgets are calculated, leading to confusion.
We plan to modify `get_budget`'s weekly interval calculation to use the previous `6` days + today to make the command more intuitive for users.
- `find` to support all properties
- Add confirmation to some data deletion commands (`delete`, `clear_transactions`, `reset_unicash`)
- Expand summary window to incomes as well
- Batch deletion/clear (by day, by month, etc)
**Find Command**
- The current `find` command is limited to searching for the name, location, and category of transactions only.
We plan to add support for searching across all properties, including date & time, amount, and transaction type.
This would allow users to have even more precise control over the scope of transactions search.
**Auto Clear Transactions List Filter**
- Currently, the `find` (as mentioned [here](UserGuide.md#find-transactions))
and `get_total_expenditure` (as mentioned [here](UserGuide.md#get-total-expenditure))
commands have a persisting filter on the current `Transactions List` configuration.
We plan to clear this filter on every command to avoid confusion.
**Deletion Confirmation**
- The data deletion commands (`delete`, `clear_transactions`, `reset_unicash`) currently do not have any
confirmation required for execution. This means that the user can enter the command and the data deletion will
be executed immediately.
We plan to add and additional step of deletion confirmation as a layer of safety for
the user's data.
**Summary Window**
- The current summary window is limited to showing the summary of expenses only.
We plan to extend this to showing a summary of incomes as well.
**Command Box**
- The current `CommandBox` only maintains user input history for up to `10` previous inputs.
We plan to support the storing of a larger number of previous user inputs.
***Add Transaction**
- Currently, there is no warning for the input of excessively high incomes or expenses.
We plan to add a warning message to alert the users when such excessive amounts are added.
### Appendix: Potential Features
Expand All @@ -1846,6 +1881,12 @@ Every user can...
- Set recurring transactions
- Support more than one global budget to allow users to set budgets for each category or different budgets for day/week/month
- Support more types of transaction such as `transfer`
- Delete transactions in batches (by day, by month, etc)
- Get suggestions for cheaper alternatives to their purchases based on their purchase history
- Manage multiple financial accounts within UniCa$h
- Get intelligent autofill suggestions for frequently input commands
- Export UniCa$h transactions data into a spreadsheet
- Import transactions from a spreadsheet into UniCa$h
### Appendix: Effort
Expand Down

0 comments on commit 09c84dd

Please sign in to comment.