ashleygoh1 / pe

0 stars 0 forks source link

inlcude more infomation in the glossay #9

Open ashleygoh1 opened 2 months ago

ashleygoh1 commented 2 months ago

can maybe include more terms. eg: Java Version A programming language and computing platform used for the InternHub application. Version 11 or higher is required for proper functioning. Terminal or Command Prompt Command-line interfaces used to interact with the operating system and run commands. JAR

image.png

soc-pe-bot commented 2 months ago

Team's Response

Similar to duplicate explanation

The 'Original' Bug

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

Missing important glossary: Archive

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.


Since archive related features are important part of this project. But this word is pretty general and may hold different meanings in different context. It would be better if it could be defined and explained more in the glossary.

I choose severity low because this is not a cosmetic thing and may lead to misunderstanding for some developers.

image.png


[original: nus-cs2103-AY2324S2/pe-interim#5384] [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 the feedback. We will consider adding definitions for some more terms which might be commonly used. The term "archive" here is used similarly to many mainstream applications (such as when you archive a post in social media, for example).

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: [replace this with your explanation]


## :question: Issue response Team chose [`response.NotInScope`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]