search

gsyndromes / pe

0 stars 0 forks source link

bug in dg #16

Open gsyndromes opened 4 years ago

gsyndromes commented 4 years ago

no implementation details on edit.

nus-pe-bot commented 4 years ago

Team's Response

Based on our knowledge, the Developer Guide is not meant to be an exhaustive listing of every single feature implementation or program execution path in the application. Refer to "Guideline: Minimal but Sufficient" in the CS2103T textbook

If not, it would not be useful to developers as it would contain a lot of unnecessary content. You may be reading it for days!

Also, why is this labelled as "severity.High"? Severity has been downgraded as this issue does not affect existing parts of the Developer Guide, which are still functional and useful to developers

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I do not believe this is considered “unnecessary content”. A whole implementation of a feature is missing!

Under this guideline, Minimal but sufficient, which can be found at https://nus-cs2103-ay1920s2.github.io/website/schedule/week9/topics.html#guideline-minimal-but-sufficient it does not talk about leaving out the implementation details of FEATURES of your program out of the DG, it only suggests to explain all features minimally.

I am sure that the "edit" command where your app allows people to edit their coupons is considered a significant enough command to show the implementation. We are user-testing this and having at least an outline of what to expect when testing this feature would be of great help compared to none.

:question: Issue severity

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

Reason for disagreement: Severity should remain high as it is an essential part of your program and the command should have at least some documentation on it for testers to be able to understand and actually test it.

Without the implementation details of this feature, developers who wish to extend on the "edit" command will have a hard time trying to understand your code written and that defeats the purpose of having a developer guide in the first place. The tester might even miss out entirely on this feature!