search

joosxi / pe

0 stars 0 forks source link

DG "Main components of architecture" section still has link to AB3's repo instead of team's repo #7

Open joosxi opened 1 year ago

joosxi commented 1 year ago

image.png

Link to AB3 repo is highlighted in the screenshot above.

nus-se-bot commented 1 year ago

Team's Response

Valid bug, thank you. Downgraded to very low in severity as we feel this would hardly have an impact on the user's ability to understand the architecture since the responsibilities of the class are also explained right in the same paragraph.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: I agree that the responsibilities were explained right in that same paragraph but the incorrect and broken link will cause confusion to readers when they click in. Such a link may also result in a negative impression towards the developing team as the user may think less highly of the team. Lastly, it will also cause inconvenience to readers who want to find out more about the class but is not able to since the link does not work, and additional effort is needed on the reader's part to find the class inside the repo folder.