macareonie / pe

0 stars 0 forks source link

Should include separate instruction for Mac users #4

Open macareonie opened 2 months ago

macareonie commented 2 months ago

Describe the bug

In the getting started section, the link for downloading java 11 under the mac/linux box directs you to the oracle site for downloading java.

It might be a nit, but it would be nice to have a link to downloading the Azul build of OpenJDK 11, or to make things easier, a link to the Mac advisory page on the CS2103 site.

This would help Mac users should they encounter issues when running the jar file

image.png

nus-pe-bot commented 2 months ago

Team's Response

Thanks for raising this and we agree that it is a nit!

However, the guide that we have provided is valid and functional for macOS users. We understand some mac users require Azul versions of Java but since it is difficult to add all of the links we added the official Oracle download site which contains the most up-to-date and supported versions for Java 11.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Upon further contemplation over the weekend, I actually feel this bug could warrant a higher severity. I initially thought that this would be a somewhat uncommon case for users as it only affects some Mac users and would just be of low severity. However, for those affected users, they would essentially be stuck with an un-runnable application or an application with gibberish content indefinitely, without proper guidance or direction to solve the issue. Furthermore, given the target users being not as technically-inclined, they would be unlikely to understand the cause of such issues, let alone decipher error messages in the terminal or figure out the proper java version/build to download instead.

I also do not think it would take that much effort adding an extra line that warns Mac users of this potential issue and to try downloading java from the Azul site instead. As mentioned in the report, a link to the CS2103 advisory page would be sufficient.

Seeing as this could potentially cause users to not be able to even run the application, it is arguable for this to be bumped up to Severity High