search

ChocoRagdoll / pe

0 stars 0 forks source link

DG bug: not enough implementation details for other commands #13

Open ChocoRagdoll opened 4 months ago

ChocoRagdoll commented 4 months ago

image.png

Currently, the implementation section only has 2 commands whose implementation details are well explained, and only sequence diagrams are used for illustration.

image.png

With so many commands at hand, including more with different types of diagrams may be better for the readers of the DG, allowing us to have a better grasp of the structure and implementation of the commands.

soc-pe-bot commented 4 months ago

Team's Response

Hi, Thank you for your kind feedback! As we believe that this will not seriously hinder future developers of the project, we will be downgrading this to severity.Low.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: It would be quite important to show possible difference in implementation details for all important commands such as add, delete, mark, etc, since they make up the most important part of the application. Also, different types of diagrams should be included instead of a repeated sequence diagram with repetitve details. I would insist that this bug is of medium severity since this basically means that the team has missed an important section of the developer guide.