blackmirag3 / pe

0 stars 0 forks source link

Usage of changing currency in UG/DG #11

Open blackmirag3 opened 4 months ago

blackmirag3 commented 4 months ago

If user edits the currency manually via file editing, the UG or DG does not warn user that pre-existing data that is loaded the next time programme is run will not be converted to new currency.

Info from Ug/DG Screenshot 2024-04-19 at 5.38.18 PM.png

Here, I manually edited currency to SGD from HKD and it preexisting expenses do not change Screenshot 2024-04-19 at 5.39.26 PM.png

nus-se-bot commented 4 months ago

Team's Response

The Currency Converter feature was intended to be executed within the CLI program and not by manually editing the data file. The UG has already warned that editing the file may lead to the application behaving unexpectedly.

However, as the program still functions as per normal and the bug only occurs when going against the instructions, I believe it should be classified as "Low".

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Manually editing text files (including default currency) is a feature declared in the UG in chapter 6.2. The feature is clearly intended to be within the V2.1 scope

Screenshot 2024-04-23 at 3.35.36 PM.png

--

From course website:

response.NotInScope: It is a valid issue but not something the team should be penalized for e.g., it was not related to features delivered in v2.1 or lower priority than the work already done in v2.1.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Referencing the defence, they claim: 1) manually editing the data file is not an intended feature 2) The program still functions as per normal and the bug only occurs when going against the instructions 3) the UG has already warned that editing the file may lead to the application behaving unexpectedly. 4) The bug should be low My response to their defence: ![Screenshot 2024-04-23 at 3.33.14 PM.png](https://raw.githubusercontent.com/blackmirag3/pe/main/files/44ba7383-46c8-48bd-8a0a-d5b08b171038.png) 1) As per my "not in scope" disagreement, manual editing (including default currency) is clearly intended as a feature in v2.1. I disagree that it is "unintended". 2) The UG instructs the advanced users to manually edit files (including default currency file) if they are "confident that they can update it correctly".

Hence, as unintended behaviour arises even when there is correct usage, I disagree that this bug pertains to "when going against the instructions", as the UG clearly mentions this as instructions. 3) The warning provided cautions that only inputs that are outside the acceptable range/format leads to unexpected behaviour. The UG basically mentions that all unexpected behaviour is the user's fault for improper use. However, it does not mention that correct inputs can still lead to incorrect output.

Hence, I disagree that "the UG has already warned" the user. In fact this forms the premise of the bug - that there are no relevant warnings cautioning wrong behaviour even if there is correct input and no fault of the user. 4) I disagree that the bug should be "low". It is expected in the UG that any user (so long as they have enough experience and are "advanced" enough) can manually edit files as part of normal operation. The programme not functioning correctly via manual currency editing is serious enough to deter usage of the feature by any reader of the UG. The UG fails to express this sufficiently and would hinder understanding of the programme. While it is a very specific feature, it is still likely to be use/tried by users in normal operations and will always result in unexpected behaviour since the feature is not correctly implemented. Not mentioning this phenomena in the UG causes a slight inconvenience, but it will definitely affect all readers when they try the feature since incorrect behaviour will always ensue. Therefore the UG would have misled every reader's understanding of how manual editing feature works (especially changing default currency) and this bug is clearly an error that deters usage of the whole feature, rather than just cause a minor inconvenience. Since this a feature that users will likely use after gaining experience with the app, the unintended behaviour is prevalent enough for the UG bug to affect most normal readers. The effect and prevalence combined leads me to believe this is a medium severity bug at least. -- Course website: severity.Low : A flaw that is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only. severity.Medium : A flaw that causes occasional inconvenience to some users but they can continue to use the product.