nus-pe-bot
commented
10 months ago Team's Response
Thank you for bringing this to my attention. I did refer it from JobFestGo and definitely should acknowledge their effort. I am deeply sorry for the oversight, and have already rectified the error and updated the acknowledge section.
Considering the minimal impact of the typo towards usage, I would like to propose a severity of veryLow. The primary purpose of Developer Guide is to facilitate a deeper understanding of the program's architecture and internal logic. So, even though there is a typo in that FAQ section, it does not affect the actual usage much.
Once again, I apologize for the oversight and any inconvenience it may have caused.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Unclear what a JobFestGo is
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.
In FAQ, JobFestGo was mentioned and not anywhere else, but it is unclear what it is.
[original: nus-cs2103-AY2324S1/pe-interim#1344] [original labels: type.DocumentationBug severity.VeryLow]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Thanks for noticing this, it is indeed a typo.
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)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** While I agree that it does not affect the readability of the DG, it is not merely a typo. Acknowledgement is a crucial component of working on software projects as it acknowledges the work done by others and properly attributes credit to them. Given that the team has already accepted the fact that they did not properly acknowledge JobFestGo and have taken the steps to do so, I would lower the severity I had originally given to **Low**, however, as mentioned, this is not merely a cosmetic issue (i.e. typo) but also a matter of integrity.
The UG FAQ's first point still refers to "JobFestGo" which I presume is the project that has been referenced for writing the documentation. No acknowledgement is found for this in the "Acknowledgements" of the DG.
Was between setting this as a medium severity or low severity I believe that acknowledgements are very important so I have left it as medium severity