tianyue58 / pe

0 stars 0 forks source link

Error message not specific enough #4

Open tianyue58 opened 3 years ago

tianyue58 commented 3 years ago

Description: When user accidentally forgets a space when entering a command (which may often happen in a CLI application) with obvious intention, a more specific error message is expected.

Steps to reproduce: student -an/David p/90001111 e/david@gmail.com a/Singapore

Expected: Error message saying “There should be a space after -a”

Actual: “Unknown command”

Screenshot 2021-11-12 at 4.23.50 PM.png

nus-pe-bot commented 3 years ago

Team's Response

This looks like a very complex input validation. It its certainly not in scope, and should probably be rejected also.

Severity also downgraded to low, because this is something that will only affect a small number of users in a way they cannot recover from. Even linux/windows commands are not so specific in their error messages.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I think this error message is too broad and could definitely be a bit more specific (e.g. by providing correct command format in the message displayed). Additionally, after detecting the "student" command word, if the argument that follows "student" does not match the expected command format, error message like "Invalid command format: possible related command formats include ..." is easy to implement and could be much helpful to the users than simply "unknown command". Hence, I think this bug is still within scope and should be accepted. Hope this explanation helps. Thank you!

Screenshot 2021-11-18 at 11.10.37 PM.png


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]