Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrong startup and launch instructions #2

Open
AlphaPyke opened this issue Nov 15, 2024 · 1 comment
Open

Wrong startup and launch instructions #2

AlphaPyke opened this issue Nov 15, 2024 · 1 comment

Comments

@AlphaPyke
Copy link
Owner

AlphaPyke commented Nov 15, 2024

image.png
Could cause issues with macOS for example as double-clicking results in an error sometimes.

@nus-se-script
Copy link

nus-se-script commented Nov 18, 2024

Team's Response

Identified same issue, already responded.

The 'Original' Bug

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

Incorrect instructions for manual testing on MacOS

The launch instruction in the Developer Guide under instructions for Manual Testing requires users to double click the jar file.

image.png

However MacOS does not permit users to open the jar file by double clicking on it as Apple cannot verify that it is free of malware. This would render the app unusable for MacOS users. The warning might also erode trust in the app.

image.png


[original: nus-cs2103-AY2425S1/pe-interim#3198] [original labels: type.DocumentationBug severity.High]

Their Response to the 'Original' Bug

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

The Developer Guide targets a technical audience (e.g., testers, developers) who are expected to possess the technical knowledge to address such issues. Navigating security warnings and permissions is a standard expectation for developers or testers familiar with manual testing on macOS.

This section appears in the Manual Testing section, where it is assumed that testers are capable of troubleshooting OS-specific challenges (such as granting permissions or bypassing security warnings). The Developer Guide focuses on explaining the technical aspects of testing, not basic user setup steps.

The User Guide, which is intended for end-users (not testers), includes a more accurate and comprehensive set of instructions for launching the application. For non-technical users, the User Guide is the recommended starting point, not the Developer Guide.

The problem stems from macOS's stricter security policies for unsigned JAR files, which is an external constraint outside the scope of the project. Addressing this would require changes unrelated to the app's functionality (e.g., acquiring an Apple Developer certificate or signing the JAR file), which may not be feasible given the constraints of the project.

Items for the Tester to Verify

❓ Issue duplicate status

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

  • I disagree

Reason for disagreement: [replace this with your explanation]


❓ Issue response

Team chose [response.NotInScope]

  • I disagree

Reason for disagreement: I understand that developers should have the basic know-how to deal with such issues however, to play safe I believe that documentation-wise, it should also be clear enough that different OS have different responses. In the first place, I believe that this is a documentation bug that first stems from AB3 since this was the original text, so I'm of the opinion that instead of double clicking, the instructions should match the instructions mentioned in the course website. Image attached below for reference:

image.png


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants