ktzy0305 / pe

0 stars 0 forks source link

Telegram Name cannot end with underscore #3

Open ktzy0305 opened 11 months ago

ktzy0305 commented 11 months ago

Command Tested:

add n/Annie Dunkins p/+610489630614 e/ann1e@gmail.com a/Opera house c/NAB t/@anniebirds

telegram_name_feature_flaw.png

nus-se-script commented 11 months ago

Team's Response

Thanks for reporting this bug report about how the Telegram Handle format information may not be sufficient for users.

While we currently do not explicitly specify that Telegram handles cannot have underscores at the end in the User Guide, we have designed the validation check with a regex pattern for valid Telegram handle formats, which includes constraints such as starting with '@' and being followed by only letters, numbers, or underscores, as well as other Telegram handle constraints (like underscores after the handle).

Upon reviewing your input scenario, we agree that explicitly mentioning the restriction in the User Guide could enhance clarity. However, after careful consideration, we have decided to categorize this as NotInScope. This is because the combination of the in-app error message instructing users to follow Telegram's constraints and the User Guide specifying acceptable characters would be able to guide users sufficiently as of now.

It's worth noting that Telegram handles cannot have underscores behind (actual Telegram handles). Hence, it is unlikely that users will key in such an input like the one above and as a result get the same error.

In fact, if the user inputs an invalid Telegram handle (due to invalid characters), the program notifies the user that the Telegram handle inputted does not satisfy Telegram handle constraints, which prompts the user to double-check their input. This helps the user in correcting the information they keyed in.

Despite categorising it as NotInScope, we will also change the bug type to type.DocumentationBug as we think this would be more of an enhancement to the clarity of the User Guide!

We appreciate you pointing this out and helping us improve our documentation! We would definitely add this in future versions of the user guide! :D

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]


## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FeatureFlaw`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]