PallonCX / pe

0 stars 0 forks source link

Indirect link to jar file in Quick Start #4

Open PallonCX opened 5 months ago

PallonCX commented 5 months ago

For the Quick Start Section, a link is provided for user to access the latest jar file. However, it leads to the team GitHub repo (https://github.com/AY2324S2-CS2103-F08-3/tp/) instead of the exact location of the jar file. User may face difficulty in finding the jar file in the repo.

Screenshot 2024-04-19 at 5.11.51 PM.png

nus-pe-bot commented 4 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Incorrect Jar file name in Quick Start

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.


The Quick Start section requires user to find a file name StaffConnect.jar.

Screenshot 2024-04-19 at 5.15.20 PM.png

But upon a quick search, there is no file with the exact name.

Screenshot 2024-04-19 at 5.15.58 PM.png

This affects the instruction in Step 4 as well, as the jar file may not have the name of StaffConnect.jar.

Screenshot 2024-04-19 at 5.16.57 PM.png


[original: nus-cs2103-AY2324S2/pe-interim#2772] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thanks for raising this. The team acknowledges that the instruction provided is vague, and could have been made clearer.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: Thanks for the developer team's response. However, I disagree that this issue (#4) is a duplicate of another issue (#5).

Concerning issue #4, my concern lies in the provided link not directing users to the exact location of the jar file, potentially causing difficulty in finding the file in the repository.

Regarding issue #5, my concern is that the given jar file name, StaffConnect.jar, may not match the exact jar file name users have. For instance, during the practical exam (PE), testers were provided with a jar file named [CS2103-F08-3][StaffConnect].jar. This discrepancy could lead to failed outcomes despite users following instructions precisely. For example, if a tester in the PE runs java -jar StaffConnect.jar they won't be able to launch the application.

According to the course website: Only the following cases can be considered duplicates: (a) The exact same bug reported multiple times. (b) Multiple buggy behaviors that are actually caused by the same defect and cannot be fixed independently (i.e., fixing one fixes the others automatically).

A screenshot is provided below as reference:

Screenshot 2024-04-23 at 9.35.05 PM.png

For this particular case, based on my elaboration, I believe it's clear that the first point is not valid, as both bugs are not exactly the same (although they both relate to the jar file).

The second point is also not valid, as fixing issue #4 involves changing the link, while fixing issue #5 may involve adding more text description to help the user. I can hardly think of a way that fixing one would automatically fix the other.

In conclusion, I disagree that issue #4 is a duplicate of issue #5.


## :question: Issue response Team chose [`response.NotInScope`] - [x] I disagree **Reason for disagreement:** Thanks for the developer team's response. However, I disagree that this issue is flagged as `response.NotInScope`. For this issue, my concern lies in the provided link not directing users to the exact location of the jar file, potentially causing difficulty in finding the file in the repository. A screenshot for an issue that can be considered `response.NotInScope` is provided below as a reference: ![Screenshot 2024-04-23 at 9.43.47 PM.png](https://raw.githubusercontent.com/PallonCX/pe/main/files/26b945f4-a200-4a89-8705-bdeb6d61f5fa.png) I believe that rectifying this issue would be simple, just by changing the link to lead to a place where the user can directly access the jar file (e.g., the release or a Google Drive folder). Furthermore, I disagree that rectifying it is less important than the work that has already been done. This is because if the user can't even access the jar file, then they can't use the application, and hence any "work that has been done already" on the application will not be visible to the user. At this point, it sounds reasonable to raise the severity to medium or high considering the potential troublesome consequence for users. However, I would like to keep it as a low severity issue, as a quick fix could be implemented to overcome this issue. In conclusion, I disagree that this issue is flagged as `response.NotInScope` and suggest it remain as a low severity documentation bug.