jackgugz / pe

0 stars 0 forks source link

Wrong JAR file name in the quick start of UG #4

Open jackgugz opened 2 years ago

jackgugz commented 2 years ago

In UG quick start section pointer 2: Download the latest modbook.jar from here.

image.png

However in the link given, the jar file is called as shown

image.png

The severity level estimated to be high as it may hinders users from even finding the correct jar file to use, letting alone using the application.

nus-pe-bot commented 2 years ago

Team's Response

We were advised by the teaching team to name the file this way, for the sake of CS2103 automated grading scripts.

Besides, there is only one JAR file to be found in the link, and it is still named modbook.jar, despite having an extra prefix for the sake of the grading scripts.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Firstly, it is a naming requirement for submission and not for jar release and therefore the reasoning of naming requirement is invalid.

Also, there is more than one jar file to be found in the link

image.png

V1.3 and all previous versions of jar file releases are in the same link (pay attention to left bottom corner for the link pointed by the jar file)

This situation leads to two different scenarios where things can go wrong:

  1. User follows the instruction in quick start section closely and cannot find the jar file with the exact same file name as previous releases are hidden by default. This disallows users to even having the application in the first place.

image.png

  1. User follows the instruction closely and download the jar file from previous releases, which may have major differences from the most updated version as per claimed in the quick start section, causing major issues to the use of the application due to mismatch between the application and the updated user guide.

However, as likelihood of such occurrences seem to be infrequent, the severity may be better set as Medium