[CS2113-F13-2] BrokeMan by namsengi11 · Pull Request #51 · nus-cs2113-AY2223S2/tp

namsengi11 · 2023-03-03T05:27:17Z

BrokeMan helps students running on low budget by organizing their budget usage and expenditures. It provides various features to help students minimize their spending and raise awareness on their spendings. It is optimized for CLI users so that budget and expenditure recording can be done quicker through entering commands.

Resolve merge conflict in nus-cs2113-AY2223S2#51

updated MESSAGE_USAGE in command classes

Added Save component for Budget and Read Component

jingyaaa · 2023-03-30T01:06:15Z

+
+![Architecture Diagram](images/ArchitectureDiagram.png)
+
+The ***architecture diagram*** given above is explains the high level design of the program.


There seems to be a typo in this sentence

jingyaaa · 2023-03-30T01:08:36Z

+
+---
+
+|Version| As a ... | I want to ...                                                         | So that I can ...                                |


User stories are repeated in the DG, there are 2 tables

jingyaaa · 2023-03-30T01:09:25Z

+
+---
+
+## implementation


"i" is in lowercase

jingyaaa · 2023-03-30T01:09:56Z

@@ -1,38 +1,253 @@
 # Developer Guide


Perhaps can add more diagrams of different types

jingyaaa · 2023-03-30T01:10:55Z

+
+## Design
+
+### Architecture


Architecture diagram is clear and well explained

denzelcjy

Nice work on trying to segment the information for better readability, can consider using more bullets, whitespaces and different font sizes in order to keep it more consistent. Can consider adding sequence diagrams, and maybe a class diagram to show how different classes interact with each other. Overall good job! 👍

denzelcjy · 2023-03-30T01:11:22Z

+   - [UI component](#ui-component)
+   - [Parser component](#parser-component)
+   - [Storage component](#storage-component)
+   - [Common classes](#common-classes)


The link here for the common classes does not seem to be working, perhaps edit the content in the link bracket to be #common-class for it to work?

denzelcjy · 2023-03-30T01:14:21Z

+4. [Appendix: Requirements](#appendix--requirements)
+5. [Appendix: Instructions for manual testing](#appendix--instructions-for-manual-testing)


These 2 links also do not seem to work when I clicked it, perhaps consider changing the '--' to '-' after 'appendix'?

denzelcjy · 2023-03-30T01:19:44Z

+x
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}

-## Design & implementation
+{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the
+original source as well}


there seems to be duplicate sentences here, can consider updating and filling it up whenever possible!

denzelcjy · 2023-03-30T01:26:49Z

+![Architecture Diagram](images/ArchitectureDiagram.png)
+
+The ***architecture diagram*** given above is explains the high level design of the program.
+
+Given below is a quick overview of the main components and how they interact with each other.
+
+**Main components of architecture**
+
+`BrokeMan` has one class [`Main`](https://github.com/AY2223S2-CS2113-F13-2/tp/blob/master/src/main/java/seedu/brokeMan/BrokeMan.java), which is responsible for:
+- At program launch: Initialises the components in the correct sequence, and connect them up with each other
+- At program termination: Shuts down the components and invokes cleanup methods where necessary.
+
+[`Common`](#common-class) represents a collection of messages used by multiple other components.


A little confused with the architecture diagram, in line 46 it mentions that "common represents a collection of messages used by multiple other components, but there seems to be no arrow associated with the "common" component in the diagram, is it supposed to be intended this way?

denzelcjy · 2023-03-30T01:29:31Z

+
+---
+
+## implementation


Can consider to change it to "Implementation" instead

denzelcjy · 2023-03-30T01:36:08Z

+### Entry
+
+Entry class is the underlying superclass for Expense and Income classes. It establishes the common attributes and
+methods that are necessary to represent Expenses and Incomes. Abstract class is used to represent their common features
+to maximize code reusability and increase maintainability.
+
+Private attributes
+
+Info: String that stores the description of the entry
+
+Amount: Double that stores the monetary value of entry
+
+Time: LocalDateTime that stores the date and time of entry
+
+Category: Category that stores the type tag of entry
+
+**Methods**
+
+Getters can be used to provide the private attributes to other classes
+
+editDescription(), editAmount(), editTime(), editCategory()
+
+* Takes in corresponding parameters to edit the private attributes.
+* Used by EntryList to make edits
+
+isSameMonth()


Nice work having a short summary as a description, can consider bolding "Private attributes" to make it aligned in formatting with the "Methods" that you already bolded below.
Can also consider adding bullets to indent the subpoints "Info, Amount, Time, Category" to increase readability!
Alternatively, maybe you could use a table as another way to display these details :)

denzelcjy · 2023-03-30T01:44:44Z

+| Priority | Version | As a ... | I want to ...                             | So that I can ...                                |
+|----------|---------|----------|-------------------------------------------|--------------------------------------------------|
+| `* * *`  | v1.0    | user     | add, delete, edit, and list my income     | manage my income                                 |
+| `* * *`  | v1.0    | user     | add, delete, edit, and list my expenses   | manage my expenses                               |
+| `* * *`  | v1.0    | user     | set and view my budget                    | set expectation of how much money I should use   |
+| `* * *`  | v1.0    | user     | view how much of the budget I spend       | manage and change my spending habit as necessary |
+| `* * *`  | v1.0    | user     | view all command that I can enter         | get help on the features if necessary            |
+| `* * *`  | v2.0    | user     | list monthly expenses, income, and budget | refer to financial status in previous months     |
+| `* * *`  | v2.0    | user     | save all my income and expenses entered   | so that I can refer to it next time I return     |


This is a second User Stories table that is almost similar to the first one above, is this supposed to be combined or meant to be an additional table? Can consider providing just 1 table to reduce confusion 👍

denzelcjy · 2023-03-30T01:45:59Z

+### SaveExpense, SaveIncome
+
+The SaveExpense and SaveIncome class deal with saving in the user inputted data locally so that it can be later accessed.
+**Methods**


Can consider adding a line break here so that "Methods" is on a new line

denzelcjy · 2023-03-30T01:50:00Z

+SortEntryByAmount()
+
+* Returns a sorted list of entry by amount of entry.
+
+SortEntryByDate()


are these 2 methods meant to be written as sortEntryByAmount and sortEntryByDate() instead? To follow the camelCase convention for method naming

Merge an updated upstream

UG update

Mnsd05

Overall, your developer guide is easy to understand, well done!

Mnsd05 · 2023-03-30T07:22:28Z

+
+![Architecture Diagram](images/ArchitectureDiagram.png)
+
+The ***architecture diagram*** given above is explains the high level design of the program.


You may add the Main class to the diagram

Mnsd05 · 2023-03-30T07:27:25Z

+### Ui component
+
+### Parser component
+
+### Command component
+
+### Storage component
+
+### EntryList component
+
+### Common class


This part is empty, you might want to delete or add the sequence diagrams for each component

Mnsd05 · 2023-03-30T07:32:04Z


-## Instructions for manual testing
+## Appendix: Instructions for manual testing

 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}


You can try to include how you give some input to the program and how the program should respond. For example:

Input: abc

Expected: Oops, I don't know what that means

Mnsd05 · 2023-03-30T07:39:54Z

+| Priority | Version | As a ... | I want to ...                             | So that I can ...                                |
+|----------|---------|----------|-------------------------------------------|--------------------------------------------------|
+| `* * *`  | v1.0    | user     | add, delete, edit, and list my income     | manage my income                                 |
+| `* * *`  | v1.0    | user     | add, delete, edit, and list my expenses   | manage my expenses                               |
+| `* * *`  | v1.0    | user     | set and view my budget                    | set expectation of how much money I should use   |
+| `* * *`  | v1.0    | user     | view how much of the budget I spend       | manage and change my spending habit as necessary |
+| `* * *`  | v1.0    | user     | view all command that I can enter         | get help on the features if necessary            |
+| `* * *`  | v2.0    | user     | list monthly expenses, income, and budget | refer to financial status in previous months     |
+| `* * *`  | v2.0    | user     | save all my income and expenses entered   | so that I can refer to it next time I return     |


Well done! I find that priority is a good feature of your user stories as it gives an idea of the most important features in your product

edited user guide

Developer Guide for Save Methods and Classes.

…/sistine-yu/tp

Added multiple J Unit test classes to test EntryList, ExpenseList, and IncomeList.

Add Entry Test

fixed bugs in set budget command

Added details for class implementation.

added samuel's image and updated aboutus.md

Add logging and reduce repetitive testing

fixed UG flaw

Copied readme also to the project root.

Test

updated UG

kyrixn pushed a commit to kyrixn/tp that referenced this pull request Mar 16, 2023

Merge pull request nus-cs2113-AY2223S2#52 from Zemdalk/fix-edit-index

526caa5

Resolve merge conflict in nus-cs2113-AY2223S2#51

Samueltansw and others added 7 commits March 24, 2023 17:51

fixed checkstyle

a382e5e

Merge pull request #62 from Samueltansw/master

5dc939e

updated MESSAGE_USAGE in command classes

Added Save component for Budget and Read Component

8799059

Added Save component for Budget and Read Component

ef38c4a

CheckStyle

5aec75a

Merge pull request #63 from AY2223S2-CS2113-F13-2/master

2e2e987

Added Save component for Budget and Read Component

Update the command list of User Guide

a593cbc

jingyaaa reviewed Mar 30, 2023

View reviewed changes

denzelcjy reviewed Mar 30, 2023

View reviewed changes

sistine-yu and others added 7 commits March 30, 2023 11:03

Update the command cheatsheet of User Guide

3e52928

Update the command cheatsheet of User Guide

cb0f1d4

Update the text ui

6527fac

Merge branch 'master' of https://github.com/sistine-yu/tp

329b632

Merge an updated upstream

Merge pull request #65 from sistine-yu/master

0e69216

UG update

updated UserGuide.md and enabled assertions in build.gradle

e543531

added table of contents for user guide

fb305b6

Mnsd05 reviewed Mar 30, 2023

View reviewed changes

Samueltansw and others added 12 commits March 30, 2023 16:20

Merge pull request #66 from Samueltansw/master

9ead250

edited user guide

Developer Guide for Save Methods and Classes.

1939efa

Merge pull request #67 from AY2223S2-CS2113-F13-2/master

547b447

Developer Guide for Save Methods and Classes.

Update DG miscellaneous

95530bf

merge the updated upstreamMerge branch 'master' of https://github.com…

82aac8f

…/sistine-yu/tp

Add Entry Test

b0ce5cf

Added multiple J Unit test classes to test EntryList, ExpenseList, and IncomeList.

Resolve checkstyle issue

8a8ced2

Resolve checkstyle issue

4f219b7

Resolve checkstyle issue

dece3a3

Resolve checkstyle issue

27515d4

Resolve contrasting save file

2f06c81

Merge pull request #69 from namsengi11/test

6be16a8

Add Entry Test

Samueltansw and others added 30 commits April 10, 2023 19:00

removed commented code

ceac7b2

fixed bugs in parser test

6067fcf

Merge pull request #185 from Samueltansw/master

dd06f95

fixed bugs in set budget command

Update DeveloperGuide.md

92430b8

Added details for class implementation.

Update DeveloperGuide.md

11bdbc7

added samuel's image and updated aboutus.md

79e4fc3

Add logging and reduce repetitive testing

3cecba8

Merge pull request #187 from Samueltansw/master

258863c

added samuel's image and updated aboutus.md

Merge pull request #186 from namsengi11/test

b916ae1

Add logging and reduce repetitive testing

updated UG

72e9066

Delete D.jpg

4681e65

Merge remote-tracking branch 'upstream/master'

4501284

Add files via upload

8038b7a

Update AboutUs.md

f38c603

Merge pull request #188 from Samueltansw/master

db2155f

fixed UG flaw

Update README.md

46a5ab1

Copied readme also to the project root.

Update README.md

9797465

Update README.md

27677e6

Update DeveloperGuide.md

834f42a

Add date limit

192e185

Merge branch 'master' of https://github.com/namsengi11/tp into test

4e0d340

Update date exception message

4d8770c

Updated tests

0df51c7

Merge pull request #189 from namsengi11/test

b1e4253

Test

updated UG

020f182

Merge remote-tracking branch 'upstream/master'

44cfc43

Merge pull request #190 from Samueltansw/master

0966b3d

updated UG

Update namsengi11.md

a85966d

Update namsengi11.md

6eff9f9

Update namsengi11.md

af30554


		![Architecture Diagram](images/ArchitectureDiagram.png)

		The *architecture diagram* given above is explains the high level design of the program.

		4. [Appendix: Requirements](#appendix--requirements)
		5. [Appendix: Instructions for manual testing](#appendix--instructions-for-manual-testing)


		---

		## implementation


		---

		## implementation

Conversation

namsengi11 commented Mar 3, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

denzelcjy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mnsd05 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants