search

choaticman / pe

0 stars 0 forks source link

Incorrect command to open application #10

Open choaticman opened 1 week ago

choaticman commented 1 week ago

It is mentioned in the installation steps, that the command to run in the terminal is java -jar EZSTATES.jar.

image.png

However, it is also mentioned that the .jar file to download is from the GitHub release.

image.png

However, the file name of the .jar file is not EZSTATES.jar.

Rationale for severity: High. Should the user follow the instructions, the application would not be able to run at all. This is in line with the examples provided in the readiness quiz, where should the user follow the instructions to a tee, they would not be able to use the application at all. (See Q17)

nus-pe-bot commented 1 week ago

Team's Response

Thank you for raising this issue regarding the incorrect JAR file name in the installation guide. While we acknowledge the oversight, we believe this should be classified as medium severity for the following reasons:

  1. The issue stems from a last-minute file name change as per requirement by the CS2103T submission standards and the change was not wasn’t updated in the user guide.
  2. Users can easily resolve it by checking the actual JAR file name, a basic CLI task expected of users as outlined in the User Guide.
  3. Although this issue could potentially cause users to be unable to open the application, this is a one-time installation issue with minimal impact and no effect on the app’s core functionality.
  4. A quick update to the documentation will prevent this issue for future users.

Relevant screenshot: image.png

We appreciate your feedback and will address this promptly in future iterations.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Medium] Originally [severity.High]

Reason for disagreement: I shall address each point individually.

  1. The naming requirement for CS2103T submission standards is only applicable to the Canvas submission, and not the .jar release on GitHub. Furthermore, this excuse should not serve as a reason for downgrading to severity.Medium as this is still an oversight made by the team.

  2. The User Guide has no reference nor mentioning that the User is expected to to check for the actual .jar file name. Furthermore, "Confident using command-based applications" is not equivalent to "User knowing to check for .jar file name". This is a huge jump in reasoning and should not be used to rationalise the downgrade in severity.

  3. For the user to be able to utilise the application's core functionality, they would need to start the application. It is akin to saying "Even if one is not able to start a car, they can still enjoy the benefits of an operating car". Though this bug does not affect the core functionality, this bug prevents the user from opening the application, and thus not be able to use the main features. Hence, this reasoning should not be used to downgrade the severity.

  4. The simplicity of a fix does not serve as a justification for the severity of the bug.

To further strengthen my stance for severity.High, in the PE Readiness Quiz, Question 17 showcased an example, where a simple typo which can be easily and clearly inferred to be "down" instead of "don" earned a severity of Medium. This bug has the same nature of the bug provided in Q17, and that the impact of this bug is bigger, and the scale of the impact is much larger.