search

obrona / pe

0 stars 0 forks source link

Traces of AdressBook in DG #10

Open obrona opened 1 week ago

obrona commented 1 week ago

There are still many traces of AddressBook in the DG, which will confuse future developers who are maintaining/extending the code base

Examples

nus-se-script commented 1 week ago

Team's Response

The classes shown in the DG are completely consistent with the classes in the project implementation, and changing all of the classes' names in the implementation just to be able to display a different name in the DG while doing the exact same functionality requires a lot of extra work for very little functional value above just making the DG look nicer.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: As a developer, I will be very confused if UML diagrams refers to classes and names that do not exist in the project. Developers, in the future, who are maintaining TalentConnect, are likely not to be former CS2103T students, they will be confused when seeing AddressBook pop up in the DG, when the app is clearly called TalentConnect, and there is no mention of another app called AddressBook in the DG.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Although this is a very silly careless mistake, but can cause occasional inconvenience to developers, as they probably will have to do extensive googling to find out what is AddressBook referring to. They would have to google and find out, themselves, that this project was evolved from CS2103T starter app AddressBook 3, when that info could have been provided right at the start, or the developers could have simply renamed all instances of AddressBook to TalentConnect, which my group did.