search

angkoonhwee / pe

0 stars 0 forks source link

Edit JSON file for student to have 2 same lab number #7

Open angkoonhwee opened 2 years ago

angkoonhwee commented 2 years ago

Steps to reproduce:

  1. Edit json file such that for one student, the student has 2 of the same lab number.
  2. After saving JSON file, launch app again.

Expected: Error message to inform user that there cannot be duplicate lab numbers.

Actual: No error, student now has 2 identical labs.

nus-pe-bot commented 2 years ago

Team's Response

This bug is unlikely to affect the normal operation of ProgrammerError. Having a lab with manually changed lab title does not prevent the lab from being deleted or edited. It does not prevent a TA from assigning a score to the manually changed lab either.

While this bug is valid and is indeed confusing for a student to have duplicated labs, editing data file directly should only be for advanced users as indicated in our UG (as shown below) to accelerate the process of creating new student lab records. TAs are thus expected to have sufficient experience in ProgrammerError before they manually edit the data file.

Screenshot 2021-11-13 204337.png

Hence, our team would accept this as a bug but with low severity.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Had there not been an explicit section in the UG "Edit The Data File Directly", it would have not been a bug. However, since there is this section, meaning that users can edit the json file directly, it means that there should have been adequate parsing for all the fields. The developers assume that advanced users should have experience in using the app/editing json files before they can start editing the data file directly. However, knowing how to edit json files/use the app does not mean that users will not make mistakes when editing the file. The advanced user might still accidentally mistype one of the student's lab number and result in a discrepancy between the lab numbers.

And according to the definition of severity.Medium, it is a flaw that users can cause occasional inconvenience to some users but they can still continue to use the product. And the lack of parsing for the lab number can certainly cause some inconveniences, such as editing the duplicated lab, to the advanced user as it allows no room for error when editing the json file. But indeed, aside from this minor inconvenience, the application is still usable. Hence, I personally feel like this qualifies for a a severity.Medium bug.