tankh99 / pe

0 stars 0 forks source link

Unnecessary capitalisation for group name and attendance #4

Open tankh99 opened 3 months ago

tankh99 commented 3 months ago

Right now, the command to add a student requires lab and tutorial names to be added such that they are capitalised. However, this is a case of unnecessary capitalisation. The application could just auto-capitalise the names for the users rather than forcing them to capitalise the names. For example, lab05 and LAB05 can be treated as a same string

Screenshot 2024-04-19 at 4.24.34 PM.png

The filter function is also related. Perhaps this capitalisation might actually be making using this application more difficult that it should be?

Screenshot 2024-04-19 at 4.49.15 PM.png

Same thing for attendance. Is there a specific reason why the application only accepts capital letters?

Screenshot 2024-04-19 at 4.51.13 PM.png

nus-pe-script commented 3 months ago

Team's Response

Thanks for the suggestion!

The reason for capitalization is to abide by the NUS naming convention of LAB/TUT/REC.

Screenshot 2024-04-22 at 14.20.44.png

Moreover, since assigning a group is a one-time event, and taking attendance only takes one upper-case character, we do not see how this can cause any major inconvenience, and the severity should be Low instead of Medium. We would also like to express that this is not our current priority, and is less important than the current work being done. According to the course site, this should make this issue fall under NotInScope.

Hope this clarifies your concern!

Screenshot 2024-04-20 at 23.59.00.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: > We would also like to express that this is not our current priority, and is less important than the current work being done

Correct me if I'm wrong, but shouldn't this project be a CLI-focused application? With the assumption that this project should be CLI-friendly, then shouldn't this feature be a priority because the application is slated to be a CLI-friendly application? This capitalisation validation feature hinders this as pressing the shift button or caps lock button each time they want to key in a group name reduces the speed at which they can execute operations

The below screenshot is from the CS2103 PE site just to support that this is indeed a valid issue

Screenshot 2024-04-23 at 8.02.51 PM.png


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** > The reason for capitalization is to abide by the NUS naming convention I agree with you that this app should follow the NUS naming standard, however, what I'm concerned about is requiring the user to type in capital letters when the application could actually allow lowercase inputs, but store it as a capitalised string. It shouldn't be very difficult as I'd done something similar in my app as well. E.g. I stored all emails in their lowercased form > Moreover, since assigning a group is a one-time event, and taking attendance only takes one upper-case character, we do not see how this can cause any major inconvenience This is not exactly true. Note that when you take attendance, you have to spell out the group on top of the attendance `mark 1 g/TUT04 w/1 a/P`. My gripe is not with the P, but the group name. Furthermore, there are many other commands which use the group name for their parameters, such as the filter, mark and mail functions, on top of the manage group commands. This indeed affects operations beyond the one-time assignment. If I'm not wrong, I would imagine that the mark command would be used the most in this application compared to the other commands by far, considering that there are ~15 students per tutorial group, and it's a weekly affair If you'd like to argue for Low, I'd suggest rebutting my main reasons for putting this as medium: 1. The group name is used in most of the application, as this is an app helping TAs manage their students