search

spinoandraptos / pe

0 stars 0 forks source link

vague error message for duplicate added to txt file #9

Open spinoandraptos opened 10 months ago

spinoandraptos commented 10 months ago

image.png

Message only shows file is corrupted, but does not help user understand why so.

soc-pe-bot commented 10 months ago

Team's Response

Thank you for your response.
Will take note of this, and make the necessary improvements in the future.

It would be good if the program could tell what is wrong in the file.
As of our current iteration, it is beyond our scope.

But thank you for your idea.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: image.png

This bug impacts are too serious to be pushed to future iterations to rectify, and it is not mentioned in the UG that users cannot directly manipulate the text file to update data. Imagine a scenario for a normal wildlife reserve clerk who already has hundreds of entries and decided to manually add in some entries from a new record by copy pasting all into the text file in one go (as it is faster than inputting one by one in CLI), and in the midst of doing so accidentally created a duplicate of one of the entries while copy pasting. In the huge list of entries it may not be easy to spot the error, and on starting the program the above error occurs and the clerk is at a loss of what to do as he is unsure of what is corrupted in the huge list of entries. Spending time to check through the list one by one is a major inconvenience for the clerk and may delay critical operations on data entries, making the impact of such a vague error message something that should be prioritised. As such, it should not be a not in scope bug.

## :question: Issue type Team chose [`type.FeatureFlaw`] Originally [`type.FunctionalityBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** ![image.png](https://raw.githubusercontent.com/spinoandraptos/pe/main/files/da8e9407-b514-4b6d-9793-5a60d99c75a0.png) ------ ![image.png](https://raw.githubusercontent.com/spinoandraptos/pe/main/files/93e29d56-0186-42f2-992c-6ef326173a1e.png) ------ This flaw is certainly not just a cosmetic flaw given that it directly affects the very usage of the program itself. Without offering helpful messages on how to rectify the file data corruption, an user can be stuck and unsure of what to do, especially if he already has plenty and plenty of data stored in the data file. He cannot simply discard of all existing data and create a new data file just to get the program back working, and if he does not discard his old data, without understanding the root problem, the program may remain unusable for the user. If the user looks through entries in the text file one by one, it will lead to great inconvenience and potential critical delays to data entries. However, this only happens to some users who accidentally create duplicate entries in the text file manually. Severity medium thus matches the impact of this bug.