soc-pe-bot
commented
4 months ago Team's Response
Thank you for pointing this out. We did overlook that. We accept it as severity-low as the reader's understanding is still largely aided by the architecture diagrams, and it affects rare instances where the reader refer to only the linked classes. In that case, given that the implementation did not change from AB3, this is likely to cause minor inconvenience only.
Items for the Tester to Verify
:question: Issue severity
Team chose [severity.Low]
Originally [severity.Medium]
- [x] I disagree
Reason for disagreement: Following tp guidelines, to qualify as a low severity bug, the flaw must "Appears only in very rare situations" and causes "a minor inconvenience only". On the other hand, for a medium severity bug, the flaw "affects some users" and "causes occasional inconvenience". We see these different severities differ in the frequency of the bug experienced by users and the inconvenience it causes users.
As future developers are reading your dg, they come in with the intention to understand your product in order to develop it further. To understand it, it is logical to want to look at your implementation and click the link that you have provided. (After all, that was the reason why you attempted to link the "Main" phrase to the Main class code in your repository in the first place).
Understanding this, as these developers try to understand your product, it is natural for them to click this incorrect link. This is not a "very rare situation". Instead at least some users will click this incorrect link and this bug will "affect some users". Thus based on frequency of the bug experienced, it is falls under medium severity.
Moreover, this bug does not cause "a minor inconvenience" as the inconvenience is significant. The link points to a completely different repository. Yes, you have argued that the code is exactly the same currently. However, as you are not the authors of AB3, the main class code in AB3 can be easily updated by its authors. There can easily be differences between the AB3 main code and your code. If users do not notice this, they would be understanding code unrelated to your product which is more than a minor inconvenience. It would waste their time and effort as after understanding irrelevant code, they may not have gained knowledge about your existing implementation. It would be an "occasional inconvenience" experienced by users who click your link. Thus, on the basis of inconvenience caused, it is a medium severity bug.
Upon clicking the main link, I expect that it will lead me to their projects code for the main component. However, it brings me to the AB3 code for the Main class.
This is problematic as the main class in ab3 is not the main class in their project. This will confuse readers.