oolongwater / pe

0 stars 0 forks source link

DG not updated with SalesContactPro #11

Open oolongwater opened 1 week ago

oolongwater commented 1 week ago

Some examples:

Screenshot 2024-11-15 at 5.02.47 PM.png Screenshot 2024-11-15 at 5.03.10 PM.png

No mention of SalesContactPro in the DG. Perhaps change all mentions of AddressBook to SalesContactPro in the DG

nus-pe-bot commented 6 days ago

Team's Response

Severity changed to low as this does not pose any issue to the usage of the app itself.

This is intended, as the app is still an address book, and in the code its called AddressBookParser. So the DG is accurate with respect to our codebase.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: This app is not called AddressBook. The instructions given were to change all instances of AddressBook to the name of your app, which you clearly did not in any instance anywhere. My bug report states you did not change your naming in the DG outside of the AddressBookParser case: "No mention of SalesContactPro in the DG." There are many other instances where you did not change the name at all. This poses obvious issues when a developer working on your app cannot even locate the class name in your diagrams (which you did not update also) and cannot understand the documentation you wrote.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** This is a flaw that affects all readers of your DG and causes major problems for readers. i.e., only problems that make the product unusable for all readers (class names cannot be found)