search

zhou-colla / pe

0 stars 0 forks source link

[Glossary] Missing JavaFx glossary item and JavaFx setup for MacOS users #6

Open zhou-colla opened 1 week ago

zhou-colla commented 1 week ago

Description: It is stated in the DG that "The UI component uses the JavaFx UI framework"

Problem Explanations on JavaFx could be included in the glossary. Furthermore, i believe it is important to emphasize that for MacOS users, Java 17 is not enough, they must have JavaFx.

Screenshot

image.png

nus-se-bot commented 1 week ago

Team's Response

Thank you for your input

However, we do not see it as a relevant information to be included in the DG. Since DG is written specifically for developers, Java and JavaFX should be a common terminology that most developers are familiar with.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response. While I understand your perspective, I respectfully disagree with the decision to exclude information about JavaFX in the Developer Guide (DG) and User Guide (UG).

User Guide (UG): For MacOS users, JavaFX is not bundled with Java 17, meaning they must install a Java runtime environment that explicitly includes JavaFX to successfully launch the application. Without clear instructions in the UG, users may struggle to troubleshoot this issue, leading to unnecessary frustration and an inability to use the app effectively. Including a brief note in the UG about JavaFX requirements ensures that users—especially those unfamiliar with technical details—can set up the app smoothly.

Developer Guide (DG): While the DG is aimed at developers, it is not safe to assume that all contributors have prior knowledge of JavaFX. Many developers, including students or junior programmers (e.g., CS2103 students like me), may wish to contribute to this project without prior exposure to JavaFX. Adding JavaFX to the glossary provides helpful context and lowers the barrier to entry for contributors, fostering inclusivity and collaboration.

Inclusivity and Clarity: Both the UG and DG should prioritize clarity and inclusivity. Briefly mentioning JavaFX in the UG ensures users can set up the application without confusion, while its inclusion in the DG glossary provides developers with the necessary foundational knowledge to work on the project confidently.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Verylow applies only to purely cosmetic issues. Importance: JavaFX is crucial to the UG and DG, first of all, all MacOS users have to use Java Runtime with JavaFx to run the programme (Not mentioned in the UG), and the explanation of JavaFx in the DG would promote Inclusivity and Clarity for rookie programmers like me. Inclusivity and Clarity: Both the UG and DG should prioritize clarity and inclusivity. Briefly mentioning JavaFX in the UG ensures users can set up the application without confusion, while its inclusion in the DG glossary provides developers with the necessary foundational knowledge to work on the project confidently.