search

SeeuSim / pe

0 stars 0 forks source link

Developer Guide: Invalid Use case list numbering #27

Open SeeuSim opened 1 year ago

SeeuSim commented 1 year ago

The numbering should be 2.1., 2.2. instead of just nesting a 1., and 2. under the main step 2.

Screenshot 2023-04-14 at 3.27.37 PM.png

soc-se-bot commented 1 year ago

Team's Response

Thank for raising this issue.

The 'Original' Bug

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

Developer Guide: Incomplete features added in list order

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.

"3. more test cases" is unclear if that is a test case, or a test case that is going to be added later, as it is included in the list sequence numbering.

"More Test cases will be added in the future." would be clearer.

Screenshot 2023-04-14 at 3.29.24 PM.png

[original: nus-cs2103-AY2223S2/pe-interim#4071] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

We don't believe that this hinders understanding.

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: The original bug deals with the inclusion of incomplete details within the guide and a mix with the formatting for a detail that is not a part of the test case.

This is a formatting flaw with the user stories/use cases. Thus, these are different and not duplicates.

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** This is a deviation from the taught standard of use cases, and as such is a cosmetic bug that warrants at least a Very Low severity.