soc-se-bot
commented
1 year ago Team's Response
The user states that the main overview of DinerDirector, Storage and Entity components are missing. Our thought process for the Components section is to list the components that are more important. Hence for our DinerDirector we did not create a section for it in the component because it is an entry point used to start the program. But we agree that it would be better if this section is in the components section to cause less confusion to the user since DinerDirector was listed as the entry point in our architecture diagram.
Furthermore, our Storage components is listed under the Utils Component section of the Developer Guide. Perhaps due to our organization of our components section that it caused confusion to the User who is reading our guide.
Regarding the Entity section we did not think it should be a separate component by itself because it is used by each of the individual compo. But we completely understand if such a section was missing from the components part because we did reference it when talking about our implementation portion.
Our team decided to accept the bug, but we feel that lowering it to Medium severity is better because majority of the information is stated in our Components and Implementation feature. Just that perhaps the sections were not organized clearly for the user to understand.
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.Medium]
Originally [severity.High]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
Based on the architecture diagram, I assume DinerDirector Component is very important, as well as Storage and Entity components maybe being 2nd/ 3rd level of importance. However, the main overview of these 3 are missing. And their definitions or what they are supposed to handle.