search

UdhayaShan1 / pe

0 stars 0 forks source link

[DG] Product is Match but documents old AddressBook #20

Open UdhayaShan1 opened 2 months ago

UdhayaShan1 commented 2 months ago

While I know the code retains AddressBook, AddressBook is a product on its own and we should not be documenting AddressBook in our diagrams.

In this sequence diagram its the same addressBook

image.png

It should be Match or its variants and may lead to confusion over which product its referring to.

nus-pe-bot commented 2 months ago

Team's Response

Hi even though our product is called Match, in our codebase the function names we used didn't change hence we believe that this diagram is the best representation of our code.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Rejecting this issue downright does not acknowledge the underlying issue of "in our codebase the function names we used didn't change" as the developers themseleves mentioned. I have also mentioned "While I know the code retains AddressBook, AddressBook is a product on its own".

I know it is matching the code and hence it could be NotInScope but I believe it is not grounds for rejection as there is an underlying issue of still mentioning AddressBook which should be changed in future iterations to ensure clarity that this Match and not AddressBook.