nus-pe-bot
commented
1 year ago Team's Response
Referring to the purpose of the user guide section, advanced users would be directed to the Commands section directly while new users will be directed to the installation section where they will encounter the warning specified.
By placing it in this section, we are warning new users to not edit the data file as it may cause issues for them. That was the intention of us putting the caution there, as it is targetted for new users.
However, for advanced users, we intended for them to head straight to the Commands section and hence not be constrained by this restriction.
Addtionally, in our FAQ, we mentioned that users will be able to "overwrite the empty data file with the data file created by HMHero in your current computer.", if they wish to transfer data from one computer to another. This highlights how we are still abiding by the project restrictions and we are not violating the constraint as mentioned by the tester as the caution only applies to new users, but not for advanced users, which is logical.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: First of all, the caution message is right after installation, and I strongly believe no matter how advanced the user is they will have to install your product to use it in the first place. The "! Caution" message with a bright red border which implies important information clearly states right after the installation "You will notice that a folder called “data” would have been created in the same folder as hmhero.jar. Do not edit this file because doing so might result in a corruption of your data, causing the application to fail!".
Let's say I install your product and it clearly warns me I should not edit anything in the data file, and it does not state anywhere in the guide I can indeed edit the json in the data folder if I am an experienced user. To the user, it is clear that your app does not support the editing of the json file and violates Constraint-Human-Editable-File.
Secondly, you mentioned that in your FAQ, users will be able to "overwrite the empty data file with the data file created by HMHero in your current computer", if they wish to transfer data from one computer to another. This is NOT the same as the constraint you have violated "Constraint-Human-Editable-File". The constraint states that users can manipulate the data file by editing fields in it, it is different from just copy over the pre-existing data file to overwrite it as stated in your FAQ. Your FAQ is saying you should not edit the fields in the data file manually, the only thing you can do is to load the file into another computer to overwrite the empty file.
Lastly, please refer to the link below to the past semester PE bug which shows that a group wrote in their UG exactly what you have written which tells users that the data file should not be edited manually. I strongly disagree that my bug should be flat out rejected. I believe it should have the exact same category as this bug I have linked that has been accepted with severity.High type.FeatureFlaw in last semesters' PE.
https://github.com/nus-cs2103-AY2223S1/pe-dev-response/issues/5549
The screenshot of the UG below asks us not to edit data file manually.
But one of the project constraints is "To allow advanced users to manipulate the data by editing the data file.".
Project constraint as shown:
Reference to past year Github Bug that was accepted as High severity feature flaw.
https://github.com/nus-cs2103-AY2223S1/pe-dev-response/issues/5549