florentianayuwono / pe

0 stars 0 forks source link

API Logic.java direct to AB3 implementation #21

Open florentianayuwono opened 1 year ago

florentianayuwono commented 1 year ago

image.png

image.png

This is very troublesome because developers might end up not understanding the product implementation at all (since they are referring to different code).

soc-se-bot commented 1 year ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Wrong links in DG direct to AB3 implementation instead

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


image.png

Clicking on these links direct to this page:

image.png


[original: nus-cs2103-AY2223S1/pe-interim#5339] [original labels: type.DocumentationBug severity.Low]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: image.png

As given in the module website, fixing the wrong links in original bug WILL NOT fix the wrong links in this issue. Therefore this bug is not duplicate.


:question: Issue severity

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

Reason for disagreement: image.png

image.png

The fact that the new developers might not be students taking CS2103 module, and therefore when learning this product they encounter a link that direct to implementation of different product (AB3), but since they do not know the context, it will be very dangerous as this developer will end up learning the wrong implementation. Based on the severity level specifies, this is actually a flaw that will affect most readers, but since weighing on the fact that there might still be some readers who are subset of CS2103, I choose to lower the severity to Medium. But this team chooses to reject the bug and did not state the reason why.

image.png

According to this, this bug should be accepted then.