xuelinglow / pe

0 stars 0 forks source link

Error message is not clear when trying to add comment in ADD command #1

Open xuelinglow opened 2 months ago

xuelinglow commented 2 months ago

image.png

Command to recreate: add n/John Doe e/asdf@gmail.com c/SG p/61234567 t/Internal m/test

It might be confusing for new users that they aren't able to add comments directly and may think its something wrong with their other prefixes instead.

According to the DG, it is noted that HireHub should raise an error and ask recruiter to use other method to add comment, but it does not reflect in the actual application.

soc-se-bot commented 2 months ago

Team's Response

Thank you for the feedback. We believe this should be a documentation bug with our DG instead of a functionality bug, as it was not written in our UG that our application would raise an error when the comment prefix is used for the add command. The primary point of reference when testing the app should be the UG instead of the DG; thus, this behaviour is expected and correct because the prefix m/ is not a valid prefix for the add command and the second tag parameter is treated as Internal m/test. This tag parameter contains a whitespace and the / character, which are not alphanumeric, which is reflected in the error message. We have also lowered the severity of the bug to low, taking into consideration it is a documentation bug with the DG, and the main point of reference when testing the app is the UG.

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]